R Language
roxygen2

parametrar

Dokumentera ett paket med roxygen2

Skriva med roxygen2

roxygen2 är ett paket skapat av Hadley Wickham för att underlätta dokumentation.

Det gör det möjligt att inkludera dokumentationen i R-skriptet, i rader som börjar med #' . De olika parametrarna som skickas till dokumentationen börjar med en @ , till exempel skaparen av ett paket kommer att skrivas enligt följande:

#' @author The Author

Om vi till exempel vill dokumentera följande funktion:

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

Vi vill skriva en liten beskrivning till den här funktionen och förklara parametrarna med följande (varje rad förklaras och detaljeras efter):

#' 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)

• Den första raden #' Mean är titeln på dokumentationen, följande rader gör korpuset.
• Varje parameter i en funktion måste specificeras genom en relevant @param . @export indikerade att det här funktionsnamnet borde exporteras och kan därför kallas när paketet laddas.
• @keyword ger relevanta nyckelord när du letar efter hjälp
• @importFrom listar alla funktioner som ska importeras från ett paket som kommer att användas i den här funktionen eller i ditt paket. Observera att importera det kompletta namnområdet för ett paket kan göras med @import
• Exemplen skrivs sedan under @example taggen.
  • Den första kommer att utvärderas när paketet är byggt;
  • Den andra kommer inte - vanligtvis för att förhindra långa beräkningar - på grund av kommandot \dontrun .

Bygg dokumentationen

Dokumentationen kan skapas med devtools::document() . Observera också att devtools::check() automatiskt skapar en dokumentation och kommer att rapportera saknade argument i dokumentationen av funktioner som varningar.