كيف يمكنني توثيق مجموعات البيانات مع 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

ينتج عن هذا ملف مساعدة يشبه هذا: