2012-09-16 22 views
8

का उपयोग कर फाइलें मेरे पास roxygen2 पैकेज का उपयोग करके मेरे आर पैकेज के लिए एक आरडी फ़ाइल बनाने के बारे में एक प्रश्न है।पैकेज आरडी फाइलें roxygen2 पैकेज

यह मुझे स्पष्ट है कि, आर कार्यों को दस्तावेज करने के लिए, मैं समारोह के ऊपर टिप्पणियां उत्पन्न करने के लिए emacs में सी-सी सी-ओ का उपयोग कर सकता हूं, और फिर roxygenize("pkg") के बाद उन्हें भर सकता हूं। इस तरह, मेरे पास आर कार्यों के लिए आरडी फाइलें हैं। हालांकि, मुझे यकीन नहीं है कि मैं डेटा उदाहरणों और पैकेज के लिए आरडी फ़ाइल कैसे प्राप्त कर सकता हूं? वर्तमान में, मैं का उपयोग डेटा उत्पन्न करने के लिए कर रहा हूं। और promptPackage("pkg")पीकेजी-पैकेज उत्पन्न करने के लिए। आरडी। मुझे इन फ़ाइलों को man फ़ोल्डर में रखना होगा, और फिर उन्हें अलग से संपादित करना होगा। मैं roxygen2 का उपयोग कर आर फ़ंक्शंस को दस्तावेज़ित करने जैसे डेटा और पैकेज को उसी तरह कैसे दस्तावेज़ित कर सकता हूं?

बहुत बहुत धन्यवाद!

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

मुझे लगता है कि आप pkg-package.Rd के लिए एक ही कर सकते हैं:

उत्तर

7

डेटा के लिए, this previous question on SO जिससे पता चलता है देखते हैं। यदि यह roxygen प्रारूप में होना चाहिए,

  • एक मैनुअल अनुवाद या
  • rd2roxygen package पर विचार करें।
+1

सहायक सुझावों के लिए धन्यवाद Dirk! मैंने .d फ़ाइलों को उत्पन्न करने के लिए 'प्रॉम्प्ट()' और 'प्रॉम्प्ट पैकेज()' का उपयोग किया, और फिर डेटा और पैकेज के लिए दोनों के लिए। Rd फ़ाइलों को 'roxygen' प्रारूप में अनुवाद करने के लिए' rd2roxygen' पैकेज 'का उपयोग करें। वे पूरी तरह से काम करते हैं :) – alittleboy