使用 roxygen2 記錄包

用 roxygen2 寫

roxygen2 是 Hadley Wickham 為方便文件而建立的軟體包。

它允許在由 #'開始的行中包含 R 指令碼中的文件。傳遞給文件的不同引數以 @ 開頭，例如包的建立者將按如下方式編寫：

#' @author The Author

例如，如果我們想要記錄以下函式：

mean<-function(x) sum(x)/length(x)

我們將要為此函式編寫一個小描述，並用以下內容解釋引數（每行將在後面解釋和詳述）：

#' Mean
#'
#' A function to compute the mean of a vector
#' @param x A numeric vector
#' @keyword mean
#' @importFrom base sum
#' @export
#' @examples
#' mean(1:3)
#' \dontrun{ mean(1:1e99) }
mean<-function(x) sum(x)/length(x)

• 第一行 #' Mean 是文件的標題，以下行是語料庫。
• 必須通過相關的 @param 詳細說明函式的每個引數。@export 表示應該匯出此函式名，因此可以在載入包時呼叫。
• @keyword 在尋求幫助時提供相關的關鍵字
• @importFrom 列出了要從將在此函式或你的包中使用的包匯入的所有函式。請注意，可以使用 @import 完成匯入包的完整名稱空間
• 然後將示例寫在 @example 標記下面。
  • 在構建包時將評估第一個;
  • 由於\dontrun 命令，第二個不會 - 通常是為了防止長時間的計算。

構建文件

可以使用 devtools::document() 建立文件。另請注意，devtools::check() 將自動建立文件，並將函式文件中缺少的引數報告為警告。