如何为自己的包创建帮助文件？

Question

我已经为每个功能创建了自己的包，其中包含描述文件和帮助文件。 现在，如果我将?mypackage::myfunction代码显示为myfunction，则显示帮助文件。但是，当我编码?mypackage时，R显示＆＃34;指定包和库中的'mypackage'没有文档：＆＃34; :(

Answer 1

如果您没有使用roxygen2（但您可能应该），则需要使用常规必填字段创建.Rd文件，包括\docType{package}。请参阅Writing R Extensions的第2.1.4节。

  

除了强制\ name和\ title以及pkgname-package之外   别名，包概述页面的唯一要求就是它   包含\ docType {package}语句。所有其他内容都是可选的。   我们建议给读者一个简短的概述   不熟悉包装的足够信息可以入手。更多   广泛的文档更好地放入包装插图中（参见   编写包装晕影）并从此页面引用，或者进入   函数，数据集或类的单独手册页。

Answer 2

假设您使用Roxygen2生成文档，某处需要保存在.R文件中的内容。

#' Title
#'
#' Description
#'
#' @docType package
#' @name varbinq
NULL

这将为您的包创建一个帮助文件，当您键入?varbinq

时可以访问该文件

有关更多信息，请参阅Hadley Wickham的书籍“R Packages”的this section。

Answer 3

如果您使用roxygen2包来记录名为“mypackage”的包，那么执行此操作的documented way是将此代码写入名为“mypackage.R”的文件中：

#' Generate R documentation from inline comments.
#'
#' Roxygen2 allows you to write documentation in comment blocks co-located
#' with code.
#'
#' The only function you're likely to need from \pkg{roxygen2} is
#' \code{\link{roxygenize}}. Otherwise refer to the vignettes to see
#' how to format the documentation.
"_PACKAGE"

然后，您将能够使用以下方式检索包的帮助页面：

??mypackage