需要記錄未在R包中導出的函數中的參數嗎？

Question

我正在使用devtools包來檢查我正在開發的包是否已准備好提交給CRAN。

通過devtools使用Roxygen2 ，我用#'@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指令也可能有效（但我沒有嘗試過）。