roxygen2

roxygen2

La premisa de roxygen2 es simple: describe tus funciones en comentarios junto a sus definiciones y roxygen2 procesará tu código fuente y comentarios para generar automáticamente archivos .Rd en man/ , NAMESPACE y, si es necesario, el campo Collate en DESCRIPTION .

Instalación

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

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

Uso

La premisa de roxygen2 es simple: describe tus funciones en comentarios junto a sus definiciones y roxygen2 procesará tu código fuente y comentarios para producir archivos Rd en el directorio man/ . Aquí hay un ejemplo simple del paquete 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 ) {
}

Cuando roxygenise() (o devtools::document() ) su paquete, estos comentarios se transformarán automáticamente al .Rd que R usa para generar la documentación que ve cuando escribe ?str_length .

Más información

Para comenzar, primero lea vignette("roxygen2") . Luego lea más sobre el componente del paquete específico que desea generar:

• Comience con vignette("rd") para aprender cómo documentar sus funciones con roxygen2.

• vignette("rd-other") analiza cómo documentar otras cosas como conjuntos de datos, el paquete en sí y las diversas piezas utilizadas por los sistemas de programación orientada a objetos de R.

• vignette("rd-formatting") proporciona los detalles del soporte de rmarkdown de roxygen2.

• vignette("reuse") demuestra las herramientas disponibles para reutilizar la documentación en varios lugares.

• vignette("namespace") describe cómo generar un archivo NAMESPACE , cómo funciona el espacio de nombres en R y cómo puede usar roxygen2 para ser específico sobre lo que su paquete necesita y suministra.

• Para el campo Collate en DESCRIPTION , consulte ?update_collate() .