Có thể đưa các tệp .R vào thư mục dữ liệu của gói của tôi trong quy trình roxygen không?Tôi làm cách nào để ghi lại các tập dữ liệu bằng roxygen?
Tôi đã đặt một vài tệp .R vào thư mục dữ liệu. Khi chúng có nguồn dữ liệu(), chúng đọc trong các tệp dữ liệu thô và thực hiện một số phép biến đổi.
Roxygen có thể được sử dụng ở bất kỳ đâu trong tệp R (nói cách khác, nó không cần phải theo sau bởi hàm). Nó cũng có thể được sử dụng để ghi lại bất kỳ docType nào trong tài liệu R.
Vì vậy, bạn chỉ có thể ghi lại dữ liệu của bạn trong một khối riêng biệt (một cái gì đó như thế này):
#' This is data to be included in my package
#'
#' @name data-name
#' @docType data
#' @author My Name \email{[email protected]@roxygen.org}
#' @references \url{data_blah.com}
#' @keywords data
NULL
Tính đến roxygen2> 4.0.0, bạn có thể ghi lại các đối tượng dữ liệu được xác định nơi khác bằng cách ghi tên của đối tượng được xác định dưới dạng chuỗi:
#' This is data to be included in my package
#'
#' @author My Name \email{[email protected]@roxygen.org}
#' @references \url{data_blah.com}
"data-name"
Tôi thấy hữu ích khi nghiên cứu các ví dụ trong gói ggplot2.
Một số điều cần chú ý:
.r tập tin duy nhất trong R thư mục của gói.Xem các ví dụ, các bộ dữ liệu 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
Điều này dẫn đến một tập tin trợ giúp trông như thế này:
Trừ bạn nên sử dụng 'NULL' thay vì 'roxygen()' để bạn không tạo ra sự phụ thuộc thời gian chạy trên 'roxygen' – hadley
Điểm tuyệt vời, cảm ơn. Thực hiện thay đổi. – Shane
@hadley: nó có thể là tốt đẹp để thêm một ví dụ như thế này vào họa tiết roxygen, và làm cho các điểm về phụ thuộc roxygen? Tôi thấy rằng có một chút khó hiểu về cách cấu trúc các tập tin. – Shane