How can I document datasets using roxygen?

Question

Is it possible to include .R files in the data directory of my package in the roxygen process?

I put several .R files in the data directory. When they are supplied with data (), they read in raw data files and perform some conversions.

Answer 1

Roxygen can be used anywhere in the R file (in other words, it should not be followed by a function). It can also be used to document any docType document in the R documentation.

So you can just document your data in a separate block (something like this):

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

As with roxygen2> 4.0.0, you can document a specific data object elsewhere by documenting the name of the object defined as a string:

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

It was useful for me to study the examples in the ggplot2 package.

See ggplot2.r on github

A few notes:

• All Roxygen codes for datasets can be included in a single .r file in the package R directory.

See examples, 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 

As a result, a help file appears that looks like this: