Bao gồm ví dụ dữ liệu trong việc phát triển các gói R

Question

Tôi mong muốn tìm hiểu làm thế nào để kết hợp ví dụ dữ liệu như văn bản nhận xét trên chức năng, chẳng hạn như:

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

tôi đặt "data.txt" của tôi tập tin trong thư mục:/pkg_Name/inst/extdata /. Tuy nhiên, R CMD kiểm tra chỉ ra lỗi trong bước này. Nếu tôi tiến hành xây dựng R CMD và R CMD cài đặt, sau đó sau khi tải gói, tôi không thể nhận được dữ liệu vào phiên R ... Bất cứ ai có thể cho tôi biết những gì đã đi sai? Đây có phải là cách chính xác để bao gồm các ví dụ dữ liệu ở cuối tài liệu trợ giúp chức năng không?

Cảm ơn rất nhiều!

Answer 1

Vui lòng xem các gói CRAN bao gồm dữ liệu và sao chép phương pháp tiếp cận của chúng. Tôi vừa thêm dữ liệu vào gói chỉ hoạt động một vài tuần trước và nó chỉ hoạt động ...

Để biết giá trị của nó là gì, hướng dẫn sử dụng có phần 1.1.5 Data in packages giải thích.

Answer 2

Hadley Wickham có một chương trong cuốn sách "R Packages" của mình trên how to incorporate data into an R Package.

Điểm Dirk vào tài liệu chính thức trên data in packages.

Ngoài ra, đây là một ví dụ về học tập từ gói ggplot2 cho một cách để kết hợp dữ liệu bằng các tệp rda và roxygen.

Here is the data directory in the ggplot2 package. Trong ví dụ này, mỗi file dữ liệu được lưu trữ trong một tệp riêng rda (ví dụ, tạo ra sử dụng save(foo, file='foo.rda')

Xem the file data.r cho lệnh Roxygen để tạo ra các tập tin trợ giúp RMD cho dữ liệu. Ví dụ,

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

Answer 3

x <- sample(1000) 
devtools::use_data(x, mtcars) 

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