我使用roxygen2
来构建我创建的包的文档。 PDF文档,看起来不错,但是当我运行help(mypackage)
我得到如何使用自行创建的R包激活help()?
No documentation for ‘mypackage’ in specified packages and libraries:
you could try ‘??mypackage’
我怎样才能让help(mypackage)
工作?
编辑:解决的办法是什么// @罗马luštrik下面:-)
我使用roxygen2
来构建我创建的包的文档。 PDF文档,看起来不错,但是当我运行help(mypackage)
我得到如何使用自行创建的R包激活help()?
No documentation for ‘mypackage’ in specified packages and libraries:
you could try ‘??mypackage’
我怎样才能让help(mypackage)
工作?
编辑:解决的办法是什么// @罗马luštrik下面:-)
我用一个<package-name>-package.R
文件,其中填充有roxygen2
文档和代码一行说:NULL
。
#' Package contains functions used in daily work by our group for ecology at
#' Department of biology, Biotechnical faculty, University of Ljubljana.
#'
#' So far the functions included in the package are:
#' \itemize{
#' \item \code{\link{readClumpp}} Read result of Clumpp into a \code{data.frame}
#' \item \code{\link{writeStructure}} Write a \code{genind} object to be analyzed using Structure
#' \item \code{\link{writeGenePop}} Write a \code{genind} object to be analyzed using GENEPOP
#' \item \code{\link{drawLoci}} Plot alleles using a list of loci
#' }
#'
#' \tabular{ll}{
#' Package: \tab zvau\cr
#' Type: \tab Package\cr
#' Version: \tab 0.2\cr
#' Date: \tab 2015-02-11\cr
#' License: \tab GPL-2\cr
#' LazyData: \tab no\cr
#' }
#'
#' @author Roman Lustrik (\email{[email protected]@emaildomain.com})(\email{[email protected]@gmail.com})
#'
#' Maintainer: Roman Lustrik (\email{[email protected]@emaildomain.com})
#' @name zvau-package
#' @import ggplot2
#' @aliases zvau
#' @docType package
#' @title Misc functions used by out group
#' @keywords package datasets
NULL
当我键入?zvau
或help(zvau)
,我得到了R.
为2以上的文件),也许你不导出您的文档中的所有“公共”的功能呢?
惊人的!谢谢 昨晚我发现这个:http://stat545.com/packages04_foofactors-package-01.html 它建议相同 – pachamaltese
链接到gh/bb/rforge回购? – hrbrmstr
图书馆(mypackage)已经加载;) – pachamaltese
@hrbrmstr当文档确定时,这将会公开可用 – pachamaltese