25

我渴望学习如何将数据示例合并为写在函数上方的注释,例如:

##' @examples 
##' ## Set working directory...
##' ## Load data into R session:
##' data <- system.file("extdata", "data.txt", package="...", sep="\t", header=TRUE, stringsAsFactors = FALSE)
##'
##' ## For reproducible results:
##' set.seed(999)

我将我的“data.txt”文件放在目录中:/pkg_Name/inst/extdata/。但是,R CMD 检查在这一步中指示错误。如果我继续 R CMD 构建和 R CMD 安装,那么在加载包后,我无法将数据输入 R 会话......谁能告诉我出了什么问题?这是在函数帮助文档末尾包含数据示例的正确方法吗?

非常感谢!

4

3 回答 3

34

Hadley Wickham has a chapter in his book "R Packages" on how to incorporate data into an R Package.

Dirk points to the official documentation on data in packages.

Alternatively, here's an example of learning from the ggplot2 package for one way of how to incorporate data using rda files and roxygen.

Here is the data directory in the ggplot2 package. In this example, each data file is stored in a separate rda file (e.g., generated using save(foo, file='foo.rda').

enter image description here

See the file data.r for the Roxygen commands to generate the Rmd help files for the data: E.g.,

#' 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:
#'
#' @format A data frame with 53940 rows and 10 variables:
#' \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 color: 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)
#' }
"diamonds"
于 2014-02-07T08:23:53.517 回答
12

请查看包含数据的 CRAN 包并复制他们的方法。几周前,我刚刚将数据添加到一个仅限工作的包中,它就可以工作......

值得一提的是,手册中有一节1.1.5 Data in packages对此进行了解释。

于 2012-09-12T15:16:14.810 回答
2
x <- sample(1000)
devtools::use_data(x, mtcars)

http://r-pkgs.had.co.nz/data.html

于 2017-08-02T05:21:23.060 回答