roxygen2

Sauerstoff2

Die Prämisse von roxygen2 ist einfach: Beschreiben Sie Ihre Funktionen in Kommentaren neben ihren Definitionen und roxygen2 verarbeitet Ihren Quellcode und Ihre Kommentare, um automatisch .Rd -Dateien in man/ , NAMESPACE und bei Bedarf im Collate Feld in DESCRIPTION zu generieren.

Installation

 # Install roxygen2 from CRAN
install.packages( " roxygen2 " )

# Or the development version from GitHub:
# install.packages("pak")
pak :: pak( " r-lib/roxygen2 " )

Verwendung

Die Prämisse von roxygen2 ist einfach: Beschreiben Sie Ihre Funktionen in Kommentaren neben ihren Definitionen und roxygen2 verarbeitet Ihren Quellcode und Ihre Kommentare, um Rd-Dateien im man/ -Verzeichnis zu erstellen. Hier ist ein einfaches Beispiel aus dem stringr-Paket:

 # ' The length of a string
# '
# ' Technically this returns the number of "code points", in a string. One
# ' code point usually corresponds to one character, but not always. For example,
# ' an u with a umlaut might be represented as a single character or as the
# ' combination a u and an umlaut.
# '
# ' @inheritParams str_detect
# ' @return A numeric vector giving number of characters (code points) in each
# '    element of the character vector. Missing string have missing length.
# ' @seealso [stringi::stri_length()] which this function wraps.
# ' @export
# ' @examples
# ' str_length(letters)
# ' str_length(NA)
# ' str_length(factor("abc"))
# ' str_length(c("i", "like", "programming", NA))
str_length <- function ( string ) {
}

Wenn Sie Ihr Paket roxygenise() (oder devtools::document() ) versehen, werden diese Kommentare automatisch in die .Rd umgewandelt, die R zum Generieren der Dokumentation verwendet, die Sie sehen, wenn Sie ?str_length eingeben.

Erfahren Sie mehr

Lesen Sie zunächst vignette("roxygen2") . Lesen Sie dann mehr über die spezifische Paketkomponente, die Sie generieren möchten:

• Beginnen Sie mit vignette("rd") um zu erfahren, wie Sie Ihre Funktionen mit roxygen2 dokumentieren.

• vignette("rd-other") erläutert, wie andere Dinge wie Datensätze, das Paket selbst und die verschiedenen Teile, die von den OOP-Systemen von R verwendet werden, dokumentiert werden.

• vignette("rd-formatting") gibt die Details der Rmarkdown-Unterstützung von roxygen2 an.

• vignette("reuse") demonstriert die verfügbaren Tools zur Wiederverwendung von Dokumentation an mehreren Stellen.

• vignette("namespace") beschreibt, wie man eine NAMESPACE Datei generiert, wie Namespace in R funktioniert und wie Sie roxygen2 verwenden können, um genau anzugeben, was Ihr Paket benötigt und bereitstellt.

• Informationen zum Feld Collate in der DESCRIPTION finden Sie unter ?update_collate() .