如何隐藏辅助函数的文档？

Question

我正在维护一个包，其中包含许多使用.rd文件记录的辅助函数。由于它们未被导出，因此用户无法轻松访问 - 这很好。但是，它们仍然显示在包帮助文件的索引中。

有没有办法从索引中删除文档，以免它混乱，但仍然可以通过help访问？

Answer 1

您可以添加名为keywords的Rd文件中的字段。除了帮助您搜索功能之外，大多数关键字都不会执行任何操作，只有一个值得注意的例外：internal。使用internal关键字标记函数会将其从索引中删除。根据{{​​3}}：

  

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

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

Answer 2

对于遇到@keywords internal无法正常工作的人来说有点麻烦；

我犯了把??PACKAGENAME和help(package="PACKAGENAME")混淆的错误。因此，让我感到困惑的是，为什么我仍然看到内部文件。 ??会加载您软件包的所有文档，并且不一定是用户帮助索引。

非常基本的错误，但是可以。