roxygen2

氧2

roxygen2 的前提很簡單：在定義旁邊的註釋中描述您的函數，roxygen2 將處理您的原始程式碼和註釋，以自動在man/ 、 NAMESPACE中產生.Rd文件，如果需要，也會在DESCRIPTION中的Collate字段中產生 .Rd 檔案。

安裝

 # Install roxygen2 from CRAN
install.packages( " roxygen2 " )

# Or the development version from GitHub:
# install.packages("pak")
pak :: pak( " r-lib/roxygen2 " )

用法

roxygen2 的前提很簡單：在定義旁邊的註釋中描述您的函數，roxygen2 將處理您的原始程式碼和註釋以在man/目錄中產生 Rd 檔案。這是 stringr 套件中的一個簡單範例：

 # ' The length of a string
# '
# ' Technically this returns the number of "code points", in a string. One
# ' code point usually corresponds to one character, but not always. For example,
# ' an u with a umlaut might be represented as a single character or as the
# ' combination a u and an umlaut.
# '
# ' @inheritParams str_detect
# ' @return A numeric vector giving number of characters (code points) in each
# '    element of the character vector. Missing string have missing length.
# ' @seealso [stringi::stri_length()] which this function wraps.
# ' @export
# ' @examples
# ' str_length(letters)
# ' str_length(NA)
# ' str_length(factor("abc"))
# ' str_length(c("i", "like", "programming", NA))
str_length <- function ( string ) {
}

當您roxygenise() （或devtools::document() ）時，您的套件中的這些註解將自動轉換為.Rd ，R 會使用該 .Rd 來產生您在鍵入?str_length時看到的文件。

了解更多

首先，請閱讀vignette("roxygen2") 。然後閱讀有關您要產生的特定包組件的更多資訊：

• 從vignette("rd")開始，了解如何使用 roxygen2 記錄您的函數。

• vignette("rd-other")討論如何記錄其他內容，例如資料集、套件本身以及 R 的 OOP 系統所使用的各個部分。

• vignette("rd-formatting")給出了 roxygen2 rmarkdown 支援的詳細資訊。

• vignette("reuse")示範了可在多個位置重複使用文件的工具。

• vignette("namespace")描述如何產生NAMESPACE檔案、命名空間在 R 中如何運作，以及如何使用 roxygen2 來具體了解您的套件所需和提供的內容。

• 有關DESCRIPTION中的Collate字段，請參閱?update_collate() 。