r - 如何隐藏帮助程序功能的文档？

Question

我正在维护一个包含许多用.rd文件记录的辅助功能的软件包。由于未导出它们，因此用户不容易访问它们-这很好。但是，它们仍显示在软件包帮助文件的索引中。

有没有一种方法可以从索引中删除文档，以使文档不会混乱，但仍可以通过help访问？

Answer 1

您可以在Rd文件中添加一个名为keywords的字段。除了帮助您搜索函数（internal）以外，大多数关键字不执行任何操作。使用internal关键字标记函数会将其从索引中删除。根据roxygen2 vignette：


@keywords keyword1 keyword2 ...添加标准化关键字。关键字是可选的，但如果存在，则必须从关键字插图中复制的预定义列表中获取。关键字不是很有用，除了@keywords internal。使用internal关键字会从文档索引中删除关联的.Rd文件中的所有功能，并禁用其某些自动测试。一个常见的用例是导出一个函数（使用@export）并将其标记为内部函数。这样，高级用户可以访问新用户是否会在索引中看到的功能而感到困惑。


在roxygen注释中添加@keywords internal将得到所需的结果。