r - Roxygen 可以忽略非用户功能吗？

Question

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

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

Answer 1

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

Answer 2

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

Answer 3

使用 internal 关键字字段 ( ie @keywords internal ) 从文档中删除该函数，并使其仅供有经验的用户使用。资料来源：roxygen2 小插图。