如何使用自己创建的 R 包激活 help()?
How to activate help() with a self created R package?
我正在使用 roxygen2
来构建我创建的包的文档。 pdf 文档看起来不错,但是当我 运行 help(mypackage)
我得到
No documentation for ‘mypackage’ in specified packages and libraries:
you could try ‘??mypackage’
我怎样才能help(mypackage)
工作?
编辑:解决方案正是@roman-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{roman.lustrik@@emaildomain.com})(\email{mjelencic@@gmail.com})
#'
#' Maintainer: Roman Lustrik (\email{roman.lustrik@@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),也许您没有导出文档中的所有 "public" 函数?
我正在使用 roxygen2
来构建我创建的包的文档。 pdf 文档看起来不错,但是当我 运行 help(mypackage)
我得到
No documentation for ‘mypackage’ in specified packages and libraries:
you could try ‘??mypackage’
我怎样才能help(mypackage)
工作?
编辑:解决方案正是@roman-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{roman.lustrik@@emaildomain.com})(\email{mjelencic@@gmail.com})
#'
#' Maintainer: Roman Lustrik (\email{roman.lustrik@@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),也许您没有导出文档中的所有 "public" 函数?