【问题标题】:Package .Rd files using roxygen2 package使用 roxygen2 包打包 .Rd 文件
【发布时间】:2012-09-16 18:10:58
【问题描述】:

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

我很清楚,为了记录 R 函数,我可以在 emacs 中使用 C-c C-o 在函数上方生成 cmets,然后填写它们,然后是 roxygenize("pkg")。这样,我就有了 R 函数的 .Rd 文件。但是,我不确定如何获取数据示例和包本身的 .Rd 文件?目前,我使用prompt("data") 生成data.RdpromptPackage("pkg") 生成pkg-package.Rd。我必须将这些文件放入man 文件夹中,然后分别进行编辑。如何以类似于使用 roxygen2 记录 R 函数的方式记录数据和打包?

非常感谢!

【问题讨论】:

    标签: r package roxygen2


    【解决方案1】:

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

    【讨论】:

    • 感谢 Dirk 提供的有用建议!我使用prompt()promptPackage() 生成.Rd 文件,然后使用rd2roxygen 包将.Rd 文件转换为roxygen 格式,用于数据和包本身。他们完美地工作:)
    猜你喜欢
    • 1970-01-01
    • 2015-06-25
    • 2017-07-24
    • 1970-01-01
    • 2015-07-06
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2020-07-09
    相关资源
    最近更新 更多