Roxygen 可以忽略非用户功能吗？答案

【问题标题】：Can Roxygen ignore non-user functions?Roxygen 可以忽略非用户功能吗？
【发布时间】：2011-01-19 22:57:03
【问题描述】：

我刚刚开始使用roxygen 包，到目前为止我对结果非常满意。不过我想知道，有没有办法指定roxygen 它应该忽略某些用户不可访问的功能？

具体来说，我不想弹出.Rd 文件，因为我在我的包中使用了.onLoad() 挂钩。这个函数已经记录在 base 包中，所以我没有理由重新记录它。

【问题讨论】：

【解决方案1】：

好吧，我终于在R-forge 找到并浏览了 Roxygen-devel 列表，看看何时实施，它似乎已经在 CRAN 上的 Roxygen 版本中。关键是在调用roxygenize()时指定use.Rd2=TRUE。在这种模式下，Roxygen 将跳过为任何前面没有 Roxygen cmets 的函数创建文档。

【讨论】：

在 roxygen2 中，即使您有 roxygen2 文档，您也可以使用 @noRd 来禁止创建 Rd 文件。

【解决方案2】：

这是他们的待办事项列表 - 在下一个版本中，只有具有 roxygen 文档的函数才会创建 man 文件。

【讨论】：

【解决方案3】：

使用内部关键字字段（即 @keywords internal）从文档中删除该功能，并使其仅适用于有经验的用户。来源：roxygen2 vignette。

【讨论】：