从R包手册中排除功能

Question

我正在写一个R包，并且我用roxygen2记录了我的所有功能。但是，我不希望所有功能都出现在软件包的手册中。 如何指定应在包装手册中显示哪些功能，或哪些功能不应出现？

我知道用一个前导点命名一个函数，例如.f <- function()代替f <- function()是一种解决方案。还有其他解决方案吗？

Answer 1

我在Hadley Wickham的优秀书籍R packages中错过了以下细节（在对象文档部分）：

  

@keywords keyword1 keyword2 ...添加标准化关键字。关键字是可选的，但如果存在，则必须从file.path中找到的预定义列表中获取（R.home（＆＃34; doc＆＃34;），＆＃34; KEYWORDS＆＃34;）。

     

通常，除了@keywords internal之外，关键字没有那么有用。 使用internal关键字会从包索引中删除该功能，并禁用其部分自动测试。将@keywords内部用于扩展您的软件包的其他开发人员感兴趣的函数是常见的，但不是大多数用户。

因此，将@keywords internal添加到roxygen2函数文档会导致函数未出现在包手册/索引中，同时仍然可以在加载包后访问帮助页面。