आर आर सीएमडी चेक

Question

के साथ संदर्भ मैनुअल बनाएं मैं एक आर पैकेज लिख रहा हूं और पैकेज में सभी कार्यों का पीडीएफ संदर्भ मैनुअल बनाना चाहता हूं। मैं here से समझ गया कि R CMD check स्वचालित रूप से एक संदर्भ पुस्तिका बनाता है।

Here मैंने पढ़ा है कि मैन्युअल प्रविष्टि "NAMESPACE के निर्यात खंड में सूचीबद्ध कार्यों" का निर्माण किया गया है।

मेरे NAMESPACE फ़ाइल के रूप में निम्नानुसार है:

# Export all names 
exportPattern(".") 

# Import all packages listed as Imports or Depends 
import(
    LIM 
) 

इसलिए मैंने सोचा कि सब कुछ निर्यात किया जाएगा। R CMD check पैकेज निर्देशिका पर, बहुत अंत में के दौरान यह कहते हैं:

* checking PDF version of manual ... OK 

हालांकि, मैं अपने पैकेज निर्देशिका में एक संदर्भ पुस्तिका भी नहीं मिलता है (मुझे लगता है कि इसे Inst/दस्तावेज़ में होगा)। मुझे यहां क्या समझ नहीं आ रहा है?

संपादित

के रूप में पॉल Hiemstra ने कहा, मैं .Rd प्रलेखन फ़ाइलों की जरूरत है। मेरे पैकेज में सभी फ़ंक्शंस और डेटासेट में .Rd पैकेज की man/ निर्देशिका में फ़ाइलें हैं। मुझे अभी भी संदर्भ मैनुअल युक्त पीडीएफ नहीं मिल रहा है।

Answer 1

R CMD check एक निर्देशिका PACKAGE.RCheck बनाता है। इस निर्देशिका में आप फ़ाइल PACKAGE-manual.pdf पा सकते हैं।

Answer 2

एक और तरीका संदर्भ मैनुअल सीधे का उपयोग कर बनाने के लिए है:

R CMD Rd2pdf mypackage 

जहां mypackage अपने .Rd फाइलों के साथ man फ़ोल्डर सहित अपने आर पैकेज कोड फ़ोल्डर संरचना वाले फ़ोल्डर है।

किसी कारण से मुझे आरस्टूडियो में निर्माण या जांच के दौरान संदर्भ मैनुअल कभी नहीं मिलता है, क्योंकि शायद कहीं कहीं एक सेटिंग याद आ गई है। लेकिन इस तरह के आदेश को चलाने के साथ-साथ ठीक काम करता है।

Answer 3

मुझे एक ही समस्या थी। ऐसा लगता है कि जब आप '--no-manual' का डिफ़ॉल्ट तर्क आरएमडी विकल्पों में जोड़े जाते हैं, तो जब आप Rstudio (devtools का उपयोग करते समय) में बिल्ड या चेक पर क्लिक करते हैं।

मैं मैन्युअल रूप से आर कमांड प्रॉम्प्ट में तर्क देकर इस हल:

library(devtools) 

check(cleanup = FALSE,manual = TRUE,path = getwd()) 

# without running the examples 
check(cleanup = FALSE,args = c('--no-examples'),manual = TRUE,path = getwd()) 

इस मामले में, एक फ़ोल्डर package.Rcheck कहा जाता है के रूप में पैकेज-manual.pdf

इसके अलावा मैनुअल में शामिल होंगे चेक के दौरान आउटपुट में किसी भी त्रुटि की जांच करें। ऐसे वर्ण हो सकते हैं जो दस्तावेज़ को क्रैश कर सकते हैं।

एचटीएच