使用roxygen2包打包.Rd文件

时间:2012-09-16 18:10:58

标签: r package roxygen2

我有一个问题,即使用roxygen2包为我的R包创建.Rd文件。

我很清楚,为了记录R函数,我可以在emacs中使用C-c C-o在函数上方生成注释,然后填写它们,然后是roxygenize("pkg")。这样,我有R函数的.Rd文件。但是,我不知道如何获得数据示例和包本身的.Rd文件?目前,我使用prompt("data")生成 data.Rd promptPackage("pkg")来生成 pkg-package.Rd 。我必须将这些文件放入man文件夹,然后单独编辑它们。如何以类似的方式记录数据和包,例如使用roxygen2记录R函数?

非常感谢!

1 个答案:

答案 0 :(得分:7)

有关数据,请参阅this previous question on 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格式,请考虑