【问题标题】:Using Roxygen2 for my utility functions将 Roxygen2 用于我的实用程序功能
【发布时间】:2017-05-31 19:40:05
【问题描述】:

在我的分析项目(不是一个包)中,我通常在不同的分析脚本中有我source() 的实用函数。

我一直在使用 Roxygen2 文档约定(例如,以 #' 开头的文档,这在 RStudio 中得到了很好的支持。

我可以通过help(my_utility_function) 提供这些文档吗?到目前为止,我阅读的所有内容都在包的上下文中使用 Roxygen2devtools::document()。确实,当我尝试使用devtools::document() 时,它抱怨找不到包根目录。

【问题讨论】:

    标签: r documentation roxygen2


    【解决方案1】:

    你需要把它做成一个包。

    【讨论】:

    • 您有任何解决方案来记录实用功能吗?当我想了解它的论点时,我应该只是“去源头”吗?
    • @Heisenberg 我的建议是……制作一个包裹。 :) 这也是分发工作的一种巧妙方式。
    猜你喜欢
    • 2017-09-21
    • 2023-03-16
    • 1970-01-01
    • 1970-01-01
    • 2010-12-09
    • 1970-01-01
    • 1970-01-01
    • 2013-06-21
    • 2014-05-14
    相关资源
    最近更新 更多