我刚刚开始使用roxygen
软件包,我对目前的结果非常满意。然而,我想知道,有没有办法指定roxygen
它应该忽略某些不能用户访问的函数?Roxygen可以忽略非用户功能吗?
具体而言,我宁愿没有.Rd
文件弹出,因为我在我的包中使用了.onLoad()
钩子。此功能已在base
包中记录,因此我没有理由重新记录它。
我刚刚开始使用roxygen
软件包,我对目前的结果非常满意。然而,我想知道,有没有办法指定roxygen
它应该忽略某些不能用户访问的函数?Roxygen可以忽略非用户功能吗?
具体而言,我宁愿没有.Rd
文件弹出,因为我在我的包中使用了.onLoad()
钩子。此功能已在base
包中记录,因此我没有理由重新记录它。
嗯,我终于找到并浏览了Roxygen-devel列表R-forge,看看它何时会实现,它似乎已经在CRAN上的Roxygen版本中。关键是在致电roxygenize()
时指定use.Rd2=TRUE
。在此模式下,Roxygen将跳过为Roxygen评论之前未提供的任何功能创建文档。
这是在他们的待办事项列表中 - 在下一个版本中,只有具有roxygen文档的功能才会创建man文件。
+1感谢您的关注。 – Shane 2010-02-23 18:25:30
在roxygen2中,即使您有roxygen2文档,您也可以使用'@ noRd'来禁止在Rd文件上创建。 – hadley 2014-03-23 23:10:18