我正在更新CRAN上的一个软件包,遇到了CRAN检查的问题。我有一些内部函数被其他函数引用,但它们本身不需要文档/它们本身不意味着可以被软件包的用户访问。但是,CRAN检查返回警告:检查:是否缺少文档条目,结果:警告未记录的代码对象:然后列出这个内部函数。在检查文档时,告诉CRAN忽略这些函数的适当方法是什么?谢谢!这些内部函数都不是新的,所以我不知道为什么现在会产生问题,而以前的包更新没有。
svujldwt1#
@noRd
如果要使用roxygen 2文档标记而不生成.Rd文件,则可以使用@诺德来禁止为给定主题生成文件。如果你想使用roxygen 2约定来记录一个内部函数,这是很有用的;只有阅读源文档的人才能阅读文档。https://roxygen2.r-lib.org/articles/rd.html#indexing
1条答案
按热度按时间svujldwt1#
如果要使用roxygen 2文档标记而不生成.Rd文件,则可以使用@诺德来禁止为给定主题生成文件。如果你想使用roxygen 2约定来记录一个内部函数,这是很有用的;只有阅读源文档的人才能阅读文档。
https://roxygen2.r-lib.org/articles/rd.html#indexing