需要记录未在 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

指令。在这种情况下，我的解决方案是使用常规的

#

评论而不是

#'

。

基于这个答案，明确的

@keywords internal

指令也可能有效（但我还没有尝试过）。

@mattb 指出指定

@noRd

也应该有效。