Как я могу документировать наборы данных с roxygen?

Question

Можно ли включать файлы .R в каталог данных моего пакета в процесс roxygen?

Я поместил несколько файлов .R в каталог данных. Когда они получены из data (), они читают в файлах необработанных данных и выполняют некоторые преобразования.

Answer 1

Roxygen можно использовать в любом месте R-файла (другими словами, за ним не обязательно должна следовать функция). Его также можно использовать для документирования любого docType в документации R.

Таким образом, вы можете просто документировать свои данные в отдельном блоке (что-то вроде этого):

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

Начиная с roxygen2> 4.0.0, вы можете задокументировать определенный объект данных в другом месте путем документирования имени объекта, определенного как строка:

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

Мне показалось полезным изучить примеры в пакете ggplot2.

См. ggplot2.r на github

Несколько замечаний:

• Весь код Roxygen для наборов данных может быть включен в один файл .r в каталоге R пакета.

См., Например, набор данных 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

В результате получается файл справки, который выглядит следующим образом: