मैं roxygen के साथ डेटा सेट कैसे दस्तावेज़ कर सकता हूं?

Question

क्या इसमें शामिल होना संभव है। Roxygen प्रक्रिया में मेरे पैकेज की डेटा निर्देशिका में फ़ाइलें?

मैंने कई निर्देशिकाएं डाली हैं। डेटा निर्देशिका में फ़ाइलें। जब उन्हें डेटा() के साथ सोर्स किया जाता है, तो वे कच्चे डेटा फ़ाइलों में पढ़ते हैं और कुछ परिवर्तन करते हैं।

Answer 1

रोक्सीजन को आर फ़ाइल के भीतर कहीं भी इस्तेमाल किया जा सकता है (दूसरे शब्दों में, इसे किसी फ़ंक्शन द्वारा पालन नहीं करना पड़ता है)। इसका उपयोग आर दस्तावेज़ीकरण में किसी भी दस्तावेज़ टाइप करने के लिए भी किया जा सकता है।

तो आप बस एक अलग खंड में अपने डेटा (कुछ इस तरह) दस्तावेज़ कर सकते हैं:

#' 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 पैकेज में उदाहरण का अध्ययन करने के लिए मिला।

• डेटासेट के लिए सभी Roxygen कोड पैकेज के R निर्देशिका में एक भी .r फ़ाइल में शामिल किया जा सकता है:

  ggplot2.r on github

  टिप्पणी की कुछ बातें देखें।

, उदाहरण के लिए देखें 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 

यह एक मदद फ़ाइल है कि इस तरह दिखता है में परिणाम है: