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 用于生成您在键入?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() 。