R Language
roxygen2

parameters

Een pakket documenteren met roxygen2

Schrijven met roxygen2

roxygen2 is een pakket gemaakt door Hadley Wickham om documentatie te vergemakkelijken.

Hiermee kunt u de documentatie in het R-script opnemen, in regels die beginnen met #' . De verschillende parameters die worden doorgegeven aan de documentatie beginnen met een @ , bijvoorbeeld de maker van een pakket zal als volgt worden geschreven:

#' @author The Author

Als we bijvoorbeeld de volgende functie wilden documenteren:

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

We zullen een korte beschrijving van deze functie willen schrijven en de parameters met het volgende uitleggen (elke regel wordt hierna uitgelegd en gedetailleerd):

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

• De eerste regel #' Mean is de titel van de documentatie, de volgende regels vormen het corpus.
• Elke parameter van een functie moet worden gedetailleerd via een relevante @param . @export gaf aan dat deze functienaam moet worden geëxporteerd en dus kan worden opgeroepen wanneer het pakket wordt geladen.
• @keyword biedt relevante zoekwoorden wanneer u hulp zoekt
• @importFrom geeft alle functies weer die moeten worden geïmporteerd uit een pakket dat in deze functie of in uw pakket wordt gebruikt. Merk op dat het importeren van de volledige naamruimte van een pakket kan worden gedaan met @import
• De voorbeelden worden vervolgens onder de tag @example geschreven.
  • De eerste wordt geëvalueerd wanneer het pakket is gebouwd;
  • De tweede zal niet - meestal om lange berekeningen te voorkomen - te wijten aan het commando \dontrun .

Bouw van de documentatie

De documentatie kan worden gemaakt met devtools::document() . Merk ook op dat devtools::check() automatisch een documentatie maakt en ontbrekende argumenten in de documentatie van functies als waarschuwingen rapporteert.