R Language
roxygen2

Parameter

Dokumentation eines Pakets mit roxygen2

Schreiben mit roxygen2

roxygen2 ist ein Paket, das von Hadley Wickham zur Vereinfachung der Dokumentation erstellt wurde.

Es erlaubt, die Dokumentation in das R-Skript aufzunehmen, beginnend mit #' . Die verschiedenen Parameter, die an die Dokumentation übergeben werden, beginnen mit einem @ . Der Ersteller eines Pakets wird beispielsweise wie folgt geschrieben:

#' @author The Author

Zum Beispiel, wenn wir die folgende Funktion dokumentieren wollten:

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

Wir möchten eine kleine Beschreibung dieser Funktion schreiben und die Parameter mit folgendem erläutern (jede Zeile wird erklärt und detailliert beschrieben):

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

• Die erste Zeile #' Mean ist der Titel der Dokumentation, die folgenden Zeilen bilden den Korpus.
• Jeder Parameter einer Funktion muss durch ein relevantes @param detailliert sein. @export an, dass dieser Funktionsname exportiert werden sollte und daher aufgerufen werden kann, wenn das Paket geladen wird.
• @keyword liefert relevante Schlüsselwörter, wenn Sie nach Hilfe suchen
• @importFrom listet alle Funktionen auf, die aus einem Paket importiert werden sollen, das in dieser Funktion oder in @importFrom Paket verwendet wird. Beachten Sie, dass der Import des vollständigen Namespaces eines Pakets mit @import
• Die Beispiele werden dann unter dem Tag @example .
  • Die erste wird ausgewertet, wenn das Paket erstellt wird.
  • Der zweite Befehl wird aufgrund des \dontrun normalerweise nicht verwendet, um lange Berechnungen zu verhindern.

Erstellung der Dokumentation

Die Dokumentation kann mit devtools::document() . Beachten Sie auch, dass devtools::check() automatisch eine Dokumentation erstellt und fehlende Argumente in der Dokumentation der Funktionen als Warnungen meldet.