सीआरएएन सबमिशन के लिए पैकेज विगेट्स कहां रखा जाए?

Question

Writing R Extensions Manual से, मैंने पढ़ा है कि

आर 2.14.0 Sweave स्रोतों के लिए पसंदीदा स्थान से के रूप में स्रोत संकुल की उपनिर्देशिका विगनेट्स है, लेकिन आर के पिछले संस्करणों, शब्दचित्र स्रोतों के साथ संगतता के लिए विगेट्स मौजूद नहीं होने पर इंस्टेंट/डॉक में देखा जाएगा।

हालांकि, जब मैं पैकेज स्रोत के एक vignettes उप-डायरेक्टरी बनाएँ, जब मैं devtools::check() चलाने के लिए या R CMD check मैं Package vignette(s) without corresponding PDF के लिए एक चेतावनी मिलती है। अगर मैं inst/doc में विग्नेट (.Rnw और .pdf) डालता हूं तो चेक बिना किसी शिकायत के पूर्ण हो जाता है। मैंने स्थापित लाइब्रेरी पर अपनी लाइब्रेरी में देखने की कोशिश की और vignettes नामक किसी भी निर्देशिका को नहीं देखा। क्या मुझे अभी भी बहिष्कृत स्थान का उपयोग करना चाहिए?

Answer 1

आप आप के रूप में vignettes/ में .Rnw सूत्रों डाल (मेरे दो सेंट है कि यह सबसे अच्छा हो सकता है, तो आर-कोर आधिकारिक तौर पर पदावनत (और अंततः निकाल) प्रत्यक्ष स्रोत की जाँच के बजाय हमें Groundlings के सभी भ्रामक है ...) किया, लेकिन आप एक महत्वपूर्ण कदम से चूक गए; स्रोत पेड़ की जांच न करें। अपेक्षित वर्कफ़्लो स्रोत टैरबॉल बनाने और फिर उस टैरबॉल को जांचना है। टैरबॉल बनाने से विगनेट पीडीएफ बन जाएगा।

R CMD build ../foo/pkg 
R CMD check ./pkg-0.4.tar.gz 

उदाहरण ../foo/pkg के स्रोतों से स्रोत पैकेज टारबॉल का निर्माण करेगा पैकेज नाम और वर्ज़न संलग्न मौजूदा निर्देशिका में .tar.gz पैकेज बनाने के लिए

। फिर आप उस स्रोत पैकेज पर R CMD check चलाते हैं।

यदि आप चाहते हैं कि आपके विगनेट आपके लिए बनाया गया है तो इसे vignettes/ पर रखें और स्रोत पैकेज बनाएं। भविष्य की तारीख में, आर कोर inst/doc से विगनेट बनाने की क्षमता को हटा सकता है, इसलिए अब सुझाए गए स्थान के साथ जाएं और सीधे स्रोतों से बचें।

Answer 2

मुझे यह भी समझने में कठिन समय था।

मेरा मानना ​​है कि इरादा है कि आप inst/doc/ में vignettes/ में .Rnw फ़ाइल और पीडीएफ (उपयुक्त रूप से जमा) रखना चाहिए, जो तकनीकी रूप से प्रलेखन के साथ सहमत हैं यदि आप ध्यान से काफी पढ़ा है। (यानी, यह कहता है कि स्रोतvignettes/ में जाना चाहिए। मुझे नहीं लगता कि आपको inst/doc/ में इसी पीडीएफ को रखना चाहिए, लेकिन नहीं कहता है, और यह नहीं कहता है, यह व्याख्या R CMD check खुश करने लगती है ...)

संकल्प @ गेविनसिम्पसन के उत्तर में है (यानी एक को टैरबॉल बनाने की उम्मीद है और फिर स्रोत निर्देशिका की जांच करने के बजाय इसे जांचें)।