使用roxygen2包打包.Rd文件

Question

我对使用roxygen2软件包创建R软件包的.Rd文件有疑问。

我明白可以使用emacs中的C-c C-o来为R函数生成注释，然后填写它们，接着使用roxygenize("pkg")来生成.Rd文件。这样，我就可以获得用于R函数的.Rd文件。但是，我不确定如何获取数据示例和软件包本身的.Rd文件？目前，我正在使用prompt("data")来生成data.Rd，并使用promptPackage("pkg")来生成pkg-package.Rd。我必须将这些文件放入man文件夹中，然后分别进行编辑。我该如何像使用roxygen2记录R函数一样记录数据和软件包呢？

非常感谢！

- alittleboy

Answer 1

有关数据，请参见SO上的此前问题，建议如下：

#' This is data to be included in my package
#'
#' @name data-name
#' @docType data
#' @author My Name \email{blahblah@@roxygen.org}
#' @references \url{data_blah.com}
#' @keywords data
NULL

我猜你也可以对 pkg-package.Rd 做同样的事情。如果必须使用 roxygen 格式，请考虑手动翻译或使用rd2roxygen 包。

- Dirk Eddelbuettel

---

谢谢Dirk提供的有用建议！我使用prompt()和promptPackage()生成.Rd文件，然后使用rd2roxygen包将.Rd文件转换成roxygen格式，对于数据和整个包都可以。它们工作得非常完美 :) - alittleboy