需要记录未在R包中导出的函数中的参数吗？

Question

我正在使用devtools包来检查我正在开发的软件包是否已准备好提交给CRAN。

使用Roxygen2到devtools，我使用#'@export记录了少量函数，以便在加载我正在开发的包时可以使用它们。

然而，当我运行devtools::check()时，似乎我需要记录未导出的函数，即那些可能被导出的函数调用的函数，但是那些使用的函数不可用也不需要包裹。以下是devtools::check()：

输出的示例

checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'calculate_agreement'
  ‘a_assign_star’ ‘a_assign’

我是否需要记录这些参数，尽管该功能未导出？

Answer 1

我认为这里的问题（基于过去的经验）是你可能在函数的前言中使用了Roxygen评论分隔符?>。这（我非常肯定）会触发创建#'文件（以及记录参数的需要），无论您是否有.Rd指令。在这种情况下，我的解决方案是使用常规@export评论而不是#。

基于this answer，明确的#'指令也可行（但我还没有尝试过）。