Wie kann ich dokumentieren Datensätze mit roxygen?

Question

Ist es möglich, .R Dateien im Datenverzeichnis von meinem Paket im roxygen Prozess einzubeziehen?

Ich habe im Datenverzeichnis mehr .R Dateien setzen. Wenn sie mit Daten bezogen werden (), lesen sie in Rohdatendateien und einige Transformationen durchführen.

Answer 1

Roxygen kann überall innerhalb einer R-Datei verwendet wird (in anderen Worten, es muss nicht durch eine Funktion folgen). Es kann auch eine beliebige docType in der R Dokumentation zu dokumentieren verwendet werden.

So einfach Ihre Daten in einem separaten Block (so etwas wie dieses) dokumentieren können:

#' This is data to be included in my package
#'
#' @name data-name
#' @docType data
#' @author My Name \email{blahblah@@roxygen.org}
#' @references \url{data_blah.com}
#' @keywords data
NULL

Answer 2

Ab roxygen2> 4.0.0, können Sie das Datenobjekt Dokument definiert an anderer Stelle durch den Namen des Objekts zu dokumentieren als String definiert:

#' This is data to be included in my package
#'
#' @author My Name \email{blahblah@@roxygen.org}
#' @references \url{data_blah.com}
"data-name"

Answer 3

Ich fand es nützlich, die Beispiele in dem ggplot2 Paket zu untersuchen.

Siehe ggplot2.r auf Github

Ein paar Dinge zu erwähnen:

• All Roxygen Code für Datensätze in einer einzigen .r Datei im R Verzeichnis des Pakets enthalten sein können.

Siehe Beispiele, die diamonds Dataset:

#' Prices of 50,000 round cut diamonds
#'
#' A dataset containing the prices and other attributes of almost 54,000
#'  diamonds. The variables are as follows:
#'
#' \itemize{
#'   \item price. price in US dollars (\$326--\$18,823)
#'   \item carat. weight of the diamond (0.2--5.01)
#'   \item cut. quality of the cut (Fair, Good, Very Good, Premium, Ideal)
#'   \item colour. diamond colour, from J (worst) to D (best)
#'   \item clarity. a measurement of how clear the diamond is (I1 (worst), SI1, SI2, VS1, VS2, VVS1, VVS2, IF (best))
#'   \item x. length in mm (0--10.74)
#'   \item y. width in mm (0--58.9)
#'   \item z. depth in mm (0--31.8)
#'   \item depth. total depth percentage = z / mean(x, y) = 2 * z / (x + y) (43--79)
#'   \item table. width of top of diamond relative to widest point (43--95)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name diamonds
#' @usage data(diamonds)
#' @format A data frame with 53940 rows and 10 variables
NULL

Dies führt zu einer Hilfedatei, die wie folgt aussieht: