在R中使用支持功能以保持DRY的最佳方式

Question

在處理我的第一個R包時，注意到當在man目錄「man」中創建包結構時，代碼中的每個函數/方法都有一個文檔文件。

爲了保持乾爽（不要重複自己），我在循環或迭代中使用了一些函數作爲「輔助」函數。我如何告訴R我不想爲他們提供任何文檔，因爲他們不應該由最終用戶直接調用？！？！

Answer 1

如果您不通過NAMESPACE導出它們，則不需要提供文檔。

另一個（老）是太簡單了創建一個，例如internal.Rd並定義了一堆\alias{foo}, \alias{bar}, \alias{frob}，那樣Codetools也很開心。

Answer 2

感謝@ Jojoshua - 烏爾裏希和@德克 - eddelbuettel

據「寫作R附加」：

男人子目錄應包含（只）文檔在包中的R對象文件文檔（Rd）格式。文檔文件名必須以ASCII（小寫或大寫）字母或數字開頭，並具有擴展名.Rd（默認）或.rd。此外，這些名稱必須在'file：//'URL中有效，這意味着它們必須完全是ASCII並且不包含'％'。有關更多信息，請參閱編寫R文檔文件。請注意，應該記錄包中的所有用戶級對象;如果軟件包pkg包含僅供「內部」使用的用戶級對象，則它應該提供一個文件pkg-internal.Rd，它記錄所有這些對象，並明確指出這些對象不應被用戶調用。見例如例如R分佈中的封裝網格的來源。請注意，廣泛使用內部對象的軟件包在不需要記錄時請不要從其名稱空間導出這些對象（請參閱軟件包名稱空間）。

順便說一下，是否有任何約定在代碼中包含註釋，以便man直接從代碼中獲取函數描述，參數描述等？

Answer 3

使用roxygen2和devtools包來記錄你的功能並構建你的包。

#' Function 1 Title 
#' 
#' Describe what function 1 
#' does in a paragraph. This function 
#' will be exported for external use because 
#' it includes the @export tag. 
#' 
#' @param parameter1 describe the first parameter 
#' @param parameter2 describe the second parameter 
#' @examples 
#' function1(letters[1:10], 1:10) 
#' @export 
function1 <- function(parameter1, parameter2) { 
    paste(parameter1, parameter2) 
} 

#' Function 2 Title 
#' 
#' Description here. This will not 
#' be added to the NAMESPACE. 
#' 
#' @param parameter1 
function2 <- function(parameter1) { 
    parameter1 
} 

一旦你把所有的文檔，使用的工具在devtools包建，文件，檢查你的包。它會自動更新man文件和說明，並從NAMESPACE中添加/刪除功能。

document() 
build() 
check() 

我還推薦使用rbundler包來控制如何加載包。