需要在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明確@keywords internal指令也可能工作（但我沒有嘗試過）。