我正在维护一个包,其中包含许多使用.rd文件记录的辅助函数.由于它们未被导出,因此用户无法轻松访问 - 这很好.但是,它们仍然显示在包帮助文件的索引中.
有没有办法从索引中删除文档,以便它不会混乱,但仍可通过help？
seb*_*n-c 14
您可以添加一个名为Rd文件的字段keywords.大多数关键字不会做,除非什么帮助你有一个明显的例外,搜索功能:internal.使用internal关键字标记函数会将其从索引中删除.根据roxygen2插图:
@keywords keyword1 keyword2 ...添加标准化关键字.关键字是可选的,但如果存在,则必须从关键字vignette中复制的预定义列表中获取.关键字不是很有用,除了@keywords internal.使用internal关键字将从文档索引中删除关联的.Rd文件中的所有函数,并禁用其一些自动化测试.一个常见的用例是导出函数(使用@export)并将其标记为内部函数.这样,高级用户可以访问新用户在索引中看到它时会感到困惑的功能.
添加@keywords internal到roxygen注释将获得所需的结果.