R Language
roxygen2

Parametri

Documentare un pacchetto con roxygen2

Scrivere con roxygen2

roxygen2 è un pacchetto creato da Hadley Wickham per facilitare la documentazione.

Permette di includere la documentazione all'interno dello script R, nelle righe che iniziano con #' . I diversi parametri passati alla documentazione iniziano con un @ , ad esempio il creatore di un pacchetto sarà scritto come segue:

#' @author The Author

Ad esempio, se volessimo documentare la seguente funzione:

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

Vogliamo scrivere una piccola descrizione per questa funzione e spiegare i parametri con quanto segue (ogni riga verrà spiegata e dettagliata dopo):

#' 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 prima riga #' Mean è il titolo della documentazione, le linee seguenti formano il corpus.
• Ogni parametro di una funzione deve essere dettagliato attraverso un @param pertinente. @export indica che il nome di questa funzione deve essere esportato e quindi può essere chiamato quando il pacchetto viene caricato.
• @keyword fornisce parole chiave pertinenti quando cerchi aiuto
• @importFrom elenca tutte le funzioni da importare da un pacchetto che verrà utilizzato in questa funzione o nel pacchetto. Si noti che l'importazione dello spazio dei nomi completo di un pacchetto può essere eseguita con @import
• Gli esempi vengono quindi scritti sotto il tag @example .
  • Il primo verrà valutato al momento della creazione del pacchetto;
  • Il secondo non - di solito per prevenire lunghi calcoli - a causa del comando \dontrun .

Costruire la documentazione

La documentazione può essere creata usando devtools::document() . Si noti inoltre che devtools::check() creerà automaticamente una documentazione e riferirà gli argomenti mancanti nella documentazione delle funzioni come avvertenze.