题
我刚开始玩弄的roxygen
包,我已经非常满意的结果为止。但是我想知道,有没有指定roxygen
它应该忽略某些功能是不能被用户访问的方式?
具体而言,我宁愿没有一个.Rd
文件弹出,因为我使用的是.onLoad()
钩在我的包。此功能已记录在base
包,所以没有理由让我。
解决方案
好,我终于找到和在 R-锻造浏览的Roxygen-devel的列表时看到这会实现,它似乎已经在版本Roxygen的是在CRAN。关键是调用use.Rd2=TRUE
时指定roxygenize()
。在此模式下,Roxygen将跳过对未由Roxygen注释前面任何功能创建的文档。
其他提示
这是他们做的名单上 - 在未来的版本中,只有roxygen文档功能将创建人的文件。
使用内部关键字字段(即 @keywords internal
),以从文档移除功能,并使其可用于仅经验的用户。
来源: roxygen2晕影
不隶属于 StackOverflow