Comment puis-je documenter des ensembles de données avec roxygen?

Question

Est-il possible d'inclure des fichiers .R dans le répertoire de données de mon package dans le processus de roxygen?

J'ai mis plusieurs fichiers .R dans le répertoire de données. Quand ils proviennent des données (), ils lisent dans les fichiers de données brutes et effectuer quelques transformations.

Answer 1

Roxygen peut être utilisé partout dans un fichier R (en d'autres termes, il ne doit pas être suivie d'une fonction). Il peut également être utilisé pour documenter toute docType dans la documentation R.

Vous pouvez simplement documenter vos données dans un bloc séparé (quelque chose comme ça):

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

Au roxygen2> 4.0.0, vous pouvez documenter l'objet de données défini ailleurs en documentant le nom de l'objet défini comme une chaîne:

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

Je l'ai trouvé utile d'étudier les exemples dans le package ggplot2.

Voir ggplot2.r sur github

Quelques choses à noter:

• Tout le code Roxygen pour les ensembles de données peuvent être inclus dans un seul fichier .r dans le répertoire R du paquet.

Voir par exemple, l'ensemble de données diamonds:

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

Il en résulte un fichier d'aide qui ressemble à ceci: