R Language
roxygen2
Buscar..
Parámetros
| Parámetro | detalles |
|---|---|
| autor | Autor del paquete |
| ejemplos | Las siguientes líneas serán ejemplos sobre cómo usar la función documentada. |
| exportar | Para exportar la función, es decir, hacerla invocable por los usuarios del paquete. |
| importar | Paquete (s) espacio (s) de nombres para importar |
| importar de | Funciones para importar desde el paquete (primer nombre de la lista) |
| param | Parámetro de la función a documentar. |
Documentando un paquete con roxygen2
Escribiendo con roxygen2
roxygen2 es un paquete creado por Hadley Wickham para facilitar la documentación.
Permite incluir la documentación dentro del script R, en líneas que comienzan por #' . Los diferentes parámetros pasados a la documentación comienzan con una @ , por ejemplo, el creador de un paquete se escribirá de la siguiente manera:
#' @author The Author
Por ejemplo, si quisiéramos documentar la siguiente función:
mean<-function(x) sum(x)/length(x)
Queremos escribir una pequeña descripción de esta función y explicar los parámetros con lo siguiente (cada línea se explicará y se detallará más adelante):
#' 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)
- La primera línea
#' Meanes el título de la documentación, las siguientes líneas conforman el corpus. - Cada parámetro de una función debe ser detallado a través de un
@paramrelevante.@exportindicó que este nombre de función debería exportarse y, por lo tanto, se puede llamar cuando se carga el paquete. -
@keywordproporciona palabras clave relevantes al buscar ayuda -
@importFromenumera todas las funciones para importar desde un paquete que se utilizará en esta función o en su paquete. Tenga en cuenta que la importación del espacio de nombres completo de un paquete se puede hacer con@import - Los ejemplos se escriben debajo de la etiqueta
@example.- El primero será evaluado cuando se construya el paquete;
- El segundo no lo hará, generalmente para evitar cálculos largos, debido al comando
\dontrun.
Construyendo la documentación
La documentación se puede crear usando devtools::document() . Tenga en cuenta también que devtools::check() creará automáticamente una documentación e informará los argumentos que faltan en la documentación de funciones como advertencias.