आर पैकेज

Question

में स्थिर (प्रीबिबिल्ट) पीडीएफ विग्नेट का उपयोग करना एक स्थिर पीडीएफ फाइल को आरआरएएन पैकेज में "वीग्नेट" के रूप में आर 3.0 के रूप में शामिल करने का उचित तरीका क्या है?

रिक्त स्टब Rnw का उपयोग करने के लिए this document में वर्णित चाल आर 3.0 में काम नहीं कर रही है। दस्तावेज़ से पता चलता है कि \VignetteEngine{} पर आधारित एक बेहतर तरीका है लेकिन यह स्पष्ट नहीं है कि यह स्थिर पीडीएफ फाइलों के लिए कैसे काम करता है।

Answer 1

R.rsp के साथ (> = 1.19.0) आप एक छोटे से 'विगनेट्स/main.pdf.asis' पाठ होता है कि फ़ाइल को जोड़कर एक स्थिर पीडीएफ 'विगनेट्स/main.pdf' शामिल कर सकते हैं :

%\VignetteIndexEntry{My amazing package} 
%\VignetteEngine{R.rsp::asis} 

और सुनिश्चित करें:

Suggests: R.rsp 
VignetteBuilder: R.rsp 

अपने पैकेज के वर्णन फ़ाइल में। यह स्थिर एचटीएमएल विगेट्स के लिए भी काम करता है। यह R.rsp विगनेट्स में से एक में भी समझाया गया है।

Answer 2

अद्यतन 2014-06-08: एक आर पैकेज में स्थिर पीडीएफ़ और HTML फ़ाइलों सहित के लिए एक बेहतर समाधान के लिए, कैसे R.rsp का उपयोग करने पर इस सूत्र में मेरे अन्य उत्तर देखें (> = 0.19.0) और उसके R.rsp::asis विग्नेट इंजन

आपको केवल <name>.Rnw फ़ाइल की आवश्यकता है जो आपके स्थिर <name>.pdf फ़ाइल से मेल खाने वाले नाम के साथ है, उदा।

vignettes/ 
    static.pdf 
    static.Rnw 

जहां <name>.Rnw (यहाँ static.Rnw) एक न्यूनतम वैध Sweave फ़ाइल है, उदाहरण के लिए

%\VignetteIndexEntry{<title to be displayed on the R vignette index page>} 
\documentclass{article} 
\begin{document} 
\end{document} 

यह शब्दचित्र स्रोत फ़ाइल (<name>.Rnw) चाल R CMD build इसे बनाने की है, यानी आर के tools::buildVignettes() पहले Sweave जाएगा <name>.tex हमेशा की तरह में <name>.Rnw। हालांकि, buildVignettes() कैसे डिज़ाइन किया गया है, यह हमारी स्थिर <name>.pdf फ़ाइल का पता लगाएगा जैसा कि पहले से ही स्वीवे इंजन द्वारा बनाया जा रहा है और इसलिए यह उस डमी टीएक्स फ़ाइल को पीडीएफ फ़ाइल में संकलित नहीं करेगा (जो हमारी स्थिर फ़ाइल को ओवरराइट करेगा)।

यह समझने के लिए महत्वपूर्ण है कि (i) विगेट्स R CMD build के दौरान "बिल्ड" हैं, (ii) और जब निर्मित किया गया है तो उन्हें निर्मित पैकेज के inst/doc/ निर्देशिका (गायब होने पर बनाया गया) पर कॉपी किया गया है। इसके अलावा, (iii) vignettes/ निर्देशिका बिल्ड पैकेज का हिस्सा बनें, यानी <pkgname>_<version>.tar.gz फ़ाइल। तो, inst/doc/ में देखना सुनिश्चित करें।

तो, यहां स्पष्ट होने के लिए, एक डमी <name>.Rnw का उपयोग करके एक हैक माना जा सकता है जो किसी को इस रणनीति के खिलाफ रोकने का फैसला कर सकता है। हालांकि, यदि ऐसा होता है, तो गैर-स्वीवे विग्नेट इंजन बनाने के लिए पूरी तरह से संभव है जिसका एकमात्र उद्देश्य <name>.pdf फ़ाइल को संकलित करना है ... <name>.pdf फ़ाइल। आर (> = 3.0.0) में जोड़े गए गैर-स्वीवे समर्थन के कारण यह मान्य और संभव है। मैं ऐसे इंजन को आरआरएसपी पैकेज में जोड़ने पर विचार कर रहा हूं, उदाहरण के लिए \ VignetteEngine {R.rsp :: StaticPDF}। इसके साथ आपको उस डमी आरएनडब्लू फाइल को भी नहीं रखना पड़ेगा - केवल पीडीएफ फाइल।

आशा इस मदद करता है