Roxygen能否忽略非用户函数？

Question

Roxygen能否忽略非用户函数？

rroxygen

10

我刚刚开始试用roxygen包，并且目前为止非常满意结果。然而，我想知道是否有办法告诉roxygen忽略某些不可访问的函数？

具体来说，我不想因为在我的包中使用了.onLoad()钩子函数而出现一个.Rd文件。因为这个函数已经在base包中有文档记录，所以我不需要重新记录它。

- Sharpie

3个回答

2

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

- hadley

0

使用内部关键字字段（即@keywords internal）从文档中删除函数，并仅对有经验的用户提供。来源：roxygen2 vignette。

- rvezy

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Sharpie · Accepted Answer

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