Roxygen可以忽略非用户功能吗?

时间:2010-02-23 05:36:57

标签: r roxygen

我刚刚开始使用roxygen包,我对目前的结果非常满意。但是我想知道,有没有办法指定roxygen它应该忽略某些用户无法访问的功能?

具体来说,我宁愿没有弹出.Rd文件,因为我在我的包中使用了.onLoad()钩子。此功能已在base包中记录,因此我没有理由重新记录它。

3 个答案:

答案 0 :(得分:14)

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

答案 1 :(得分:2)

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

答案 2 :(得分:0)

使用内部关键字字段( @keywords internal)从文档中删除该功能,仅对有经验的用户可用。 来源:roxygen2 vignette