【问题标题】:How to activate help() with a self created R package? [closed]如何使用自己创建的 R 包激活 help()? [关闭]
【发布时间】:2016-07-23 02:13:06
【问题描述】:

我正在使用roxygen2 来构建我创建的包的文档。 pdf 文档看起来不错,但是当我运行 help(mypackage) 时,我得到了

No documentation for ‘mypackage’ in specified packages and libraries: 
you could try ‘??mypackage’

我怎样才能让help(mypackage)工作?

编辑:解决方案正是@roman-luštrik 下面所说的:-)

【问题讨论】:

  • 链接到 gh/bb/rforge 存储库?
  • 库(mypackage)已加载;)
  • 仅使用 roxygen2 不会为您提供文档。您是否真的使用roxygenize 构建了帮助文件?或者,如果您实际使用的是 devtools,您是否使用了document
  • 您需要帮助,但没有提供任何代码或指向您的 pkg 的链接。帮助是不可能的,那么
  • 这个问题很清楚。格式不正确(一个问题中有两个问题),但仍然可以回答并且有改进的余地。 @pachamaltese,请花几秒钟时间,然后通过quick tour 了解 SO 的工作原理(如何提出好的问题以及如何处理已解决的问题)。

标签: r devtools roxygen2


【解决方案1】:

我使用了一个<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

当我输入 ?zvauhelp(zvau) 时,我会在 R 中获得上述文档。

对于 2),也许您没有导出文档中的所有“公共”函数?

【讨论】:

猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2017-10-10
  • 2011-03-19
  • 1970-01-01
  • 1970-01-01
  • 2013-12-23
  • 2018-10-22
相关资源
最近更新 更多