如何使用roxygenlogging数据集？
在roxygen进程中，是否可以将.R文件包含在我的软件包的数据目录中？
我已经把几个.R文件放在数据目录中。 当他们来源于data（）时，他们读取原始数据文件并执行一些转换。
Roxygen可以在R文件中的任何地方使用（换句话说，它不必紧随其后）。 它也可以用来在R文档中logging任何docType。
所以你可以在一个单独的块中logging你的数据（如下所示）：
#' 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 从roxygen2> 4.0.0开始，可以通过logging定义为string的对象的名称来logging其他地方定义的数据对象：
#' This is data to be included in my package #' #' @author My Name \email{blahblah@@roxygen.org} #' @references \url{data_blah.com} "data-name"
我发现研究ggplot2包中的例子很有用。
请参阅github上的ggplot2.r
一些注意事项：
- 数据集的所有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
这会产生一个如下所示的帮助文件：
