代码之家 › 专栏 › 技术社区 › Sharpie

roxygen可以忽略非用户函数吗?

roxygen r

9

Sharpie · 技术社区 · 16 年前

我刚开始玩 roxygen 打包,到目前为止我对结果非常满意。不过,我想知道,有没有办法具体说明 玫瑰素 它应该忽略某些用户不可访问的函数?

具体来说,我不想 .Rd 文件弹出,因为我正在使用 .onLoad() 钩住我的包裹。此功能已记录在 base 打包,所以我没有理由重新记录它。

3 回复 | 直到 8 年前

1

14

Sharpie 16 年前

我终于找到并浏览了罗克西根·德维尔的名单 R-forge 看看什么时候可以实现这个功能,它似乎已经在克兰的roxygen版本中实现了。关键是要指定 use.Rd2=TRUE 打电话时 roxygenize() . 在这种模式下,roxygen将跳过为没有roxygen注释之前的任何函数创建文档。

2

Collin 16 年前

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

3

0

rvezy 8 年前

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