2011-10-05 8 views
14

क्या roxygen द्वारा उत्पन्न दस्तावेज में एक छवि शामिल करना संभव है? मेरे पास कई फ़ंक्शन हैं जो अनिवार्य रूप से ggplot() के लिए रैपर हैं जिन्हें मैं आउटपुट का उदाहरण दिखाकर दस्तावेज़ बनाना चाहता हूं।roxygen प्रलेखन का उपयोग कर एक छवि सहित

+0

बस सामान्य आरडी वाक्यविन्यास – hadley

+0

का उपयोग करें यदि मैं इसे पा सकता हूं, तो मैंने नहीं पूछा होगा। सिंटैक्स की एकमात्र व्यापक सूची जो मुझे मिल सकती थी वह बायोकॉन्डक्टर पर थी ... और इसमें छवि को शामिल करने के लिए वाक्यविन्यास शामिल नहीं था। –

+0

और "लेखन आर एक्सटेंशन" में भी। –

उत्तर

5

प्रति आर 2.14 की घोषणा होने के परिवर्तन सूची के रूप में:

रोड मार्कअप एक नया \ आंकड़ा टैग है ताकि आंकड़े सहायता पृष्ठों में शामिल किया जा सकता है जब HTML या LaTeX में बदला। पर पैरा() और अंक() के लिए सहायता पृष्ठ पर उदाहरण हैं।

से: http://cran.r-project.org/doc/manuals/R-exts.html#Figures

मदद के पृष्ठों में शामिल करने के लिए, \ आंकड़ा मार्कअप का उपयोग करें। तीन रूप हैं।

दो सामान्य रूप से उपयोग किए जाने वाले सरल रूप \ figure {filename} और \ figure {filename} {वैकल्पिक टेक्स्ट} हैं। इसमें HTML या LaTeX आउटपुट में आकृति की एक प्रति शामिल होगी। टेक्स्ट आउटपुट में, वैकल्पिक टेक्स्ट इसके बजाय प्रदर्शित किया जाएगा। (जब दूसरा तर्क छोड़ा जाता है, तो फ़ाइल नाम का उपयोग किया जाएगा।) फ़ाइल नाम और वैकल्पिक पाठ दोनों को वर्बैटिम पार्स किया जाएगा, और इसमें विशेष वर्ण शामिल नहीं होना चाहिए जो HTML या LaTeX में महत्वपूर्ण हैं।

विशेषज्ञ फ़ॉर्म \ figure {filename} {विकल्प: string} है। (शब्द 'विकल्प:' को टाइप किया जाना चाहिए जैसा कि दिखाया गया है और कम से कम एक स्थान के बाद।) इस रूप में, स्ट्रिंग को एचटीएमएल आईएमजी टैग में कॉपी किया गया है क्योंकि src विशेषता के बाद विशेषताओं के रूप में, या \ लाटेक्स में चित्रा मैक्रो, जिसे डिफ़ॉल्ट रूप से \ includegraphics कॉल के विकल्प के रूप में उपयोग किया जाता है। चूंकि यह असंभव है कि दोनों डिस्प्ले मोड के लिए कोई एकल स्ट्रिंग पर्याप्त होगी, विशेषज्ञ फॉर्म आमतौर पर सशर्त में लपेटा जाएगा। यह सुनिश्चित करने के लिए लेखक पर निर्भर है कि कानूनी HTML/LaTeX का उपयोग किया जाता है।

\if{html}{\figure{logo.jpg}{Our logo}} 
\if{latex}{\figure{logo.jpg}{options: width=0.5in}} 

आंकड़े युक्त फ़ाइलों निर्देशिका आदमी में संग्रहित किया जाना चाहिए: उदाहरण के लिए, दोनों HTML में एक लोगो (साधारण से फ़ॉर्म का उपयोग करके) और LaTeX (विशेषज्ञ फ़ॉर्म का उपयोग करके), निम्नलिखित इस्तेमाल किया जा सकता शामिल करने के लिए/आंकड़े। उस निर्देशिका से एक्सटेंशन .jpg, .pdf, .png और .svg वाली फ़ाइलें इंस्टॉल समय पर सहायता/आंकड़े निर्देशिका में कॉपी की जाएंगी। (पीडीएफ प्रारूप में आंकड़े अधिकांश एचटीएमएल ब्राउज़र में प्रदर्शित नहीं होंगे, लेकिन संदर्भ मैनुअल में सबसे अच्छा विकल्प हो सकता है।) \ आंकड़े निर्देश में मनुष्य/आंकड़ों के सापेक्ष फ़ाइल नाम निर्दिष्ट करें।

संबंधित मुद्दे