2012-02-21 12 views
12

में समीकरण को पार करने के लिए कैसे करें मैं एक आर पैकेज के लिए अपने कुछ कार्यों को दस्तावेज करने की प्रक्रिया में हूं।आर सहायता फ़ाइल/roxygen2

मैं roxygen मार्कअप का उपयोग कर रहा हूं, हालांकि यह मेरे प्रश्न के लिए काफी हद तक अप्रासंगिक है।

मैंने \deqn{...} का उपयोग करके मेरे दस्तावेज़ों में समीकरण डाल दिए हैं। मेरा सवाल है: क्या बाद में इस समीकरण को पार करने का कोई तरीका है?

उदाहरण के लिए, मेरी रोड फ़ाइल में:

\deqn{\label{test} 
y = mx + b 
} 

मैं बाद में की तरह कुछ कर सकते हैं: समीकरण का जिक्र करते हुए \ रेफरी {परीक्षण}

...

मैंने \eqref{test}, \ref{test} (जो दोनों को "अज्ञात मैक्रो" मिलता है और लिंक नहीं मिलता है), और \link{test} (जो comp लेंस यह फ़ंक्शन test नहीं ढूंढ सकता क्योंकि यह वास्तव में अन्य कार्यों को जोड़ने के लिए है)।

अन्यथा मुझे डर है कि मैं कुछ hacky करते हैं और -- (1) और Refer to equation (1)मैन्युअल \deqn रोड फ़ाइल में आदि के भीतर ...

अद्यतन

जनरल जवाब में जोड़ने के लिए हो सकता है प्रकट होता है होना करने के लिए " नहीं"। (एएएस ...)

हालांकि, मैं एक विग्नेट लिख सकता हूं और वहां "सामान्य" लेटेक्स/पैकेज का उपयोग कर सकता हूं। किसी भी मामले में, मैंने अभी देखा है कि मैट्रिक्स समीकरण जो मैंने अपनी रॉक्सीजन/आरडी फ़ाइल में डाल दिया है, मदद के ?myFunction संस्करण में वे भयानक लगते हैं (वे केवल शाब्दिक लेटेक्स स्रोत के रूप में दिखाई देते हैं)। जो शर्म की बात है, क्योंकि वे मदद के पीडीएफ संस्करण में सुंदर दिखते हैं।

@Iterator conditional text के अस्तित्व बताया गया है, तो मैं .Rd फाइलों में ASCII गणित प्रयास करेंगे, लेकिन पीडीएफ मैनुअल/शब्दचित्र में लेटेक्स गणित।

+0

दिलचस्प सवाल, और, वास्तव में, मैन्युअल रूप से समीकरण # एस का संदर्भ देना टिकाऊ नहीं है। यह देखते हुए कि 'आरडी' प्रारूप सिर्फ सबसे बुनियादी लाटेक्स है, और एएमएस एक्सटेंशन का समर्थन नहीं करता है, मुझे यकीन नहीं है कि यह संभव है या नहीं। ऐसा हो सकता है कि आपको इसके लिए एक विगनेट का उपयोग करना होगा। – Iterator

+0

इस समय मेरे पास "समीकरण समीकरण में ..." का एक बड़ा गुच्छा है "बड़े मैट्रिक्स समीकरण में ..." - यह थोड़ा अजीब है! (मेरे पास आरडी फ़ाइल प्रति बहुत समीकरण नहीं है हालांकि - मैं खुद को "- (1)" को 'डेकन' में हैक करने के लिए कम कर सकता हूं और फिर बस पाठ में समीकरण 1 का संदर्भ लें .. लेकिन यह बहुत गलत लगता है!) –

+1

शायद एक विगनेट जाने का एक बेहतर तरीका है? मैं अभी तक आरडी प्रारूप के साथ विशेष रूप से परिचित नहीं हूं, लेकिन मैं विशेष रूप से एक प्रलेखन प्रारूप से आकर्षित नहीं हूं जो लाटेक्स का उप-समूह प्रतीत होता है। आपका प्रश्न अच्छा है, लेकिन, आईएमओ, ऐसा इसलिए है क्योंकि यह आरडी दृष्टिकोण या आरआरडी दृष्टिकोण के लिए प्रलेखन में एक दोष में कोई दोष बताता है। (मैं भी बहुत सारे कोड और समीकरणों को दस्तावेज करना शुरू कर रहा हूं, इसलिए जांच के लिए मेरे प्रश्नों की कतार में मेरा एक ही सवाल है।) – Iterator

उत्तर

5

मैं दूसरों के लाभ के लिए उत्तर में मेरी टिप्पणियों को एक उत्तर में संकलित कर रहा हूं।

सबसे पहले, मुझे वास्तव में पता नहीं है कि आरआरडी समीकरणों की टैगिंग का समर्थन करता है या नहीं। हालांकि, आरडी प्रारूप लाटेक्स का इतना सख्त सबसेट है, और बहुत ही प्राचीन पाठ आउटपुट उत्पन्न करता है, जो कि इसके प्रारूप में व्यापक समीकरणों को उपयोगकर्ता के लिए बहुत लाभ के बिना एक दर्दनाक उपक्रम हो सकता है।

विकल्प package vignettes, या यहाँ तक कि बाहर से की मेजबानी की प्रलेखन उपयोग करने के लिए (के रूप में अपने संकुल में से कुछ के लिए, हैडली विकहैम द्वारा किया जाता है) है। यह आपको अपने दिल की सामग्री के लिए पीडीएफ या अन्य दस्तावेज का उपयोग करने की अनुमति देगा। इस तरह, आप स्क्रीनशॉट, प्लॉट्स, सभी मजेदार लाटेक्स एक्सटेंशन को शामिल कर सकते हैं जो केवल आपके पास हैं, और, सबसे महत्वपूर्ण रूप से, एएमएस एक्सटेंशन जिन्हें हम सभी जानते हैं और प्यार करते हैं।

फिर भी, कोई इंटरफ़ेस के आधार पर दस्तावेज़ (आरडी में) के किसी दिए गए अनुभाग के विभिन्न प्रतिपादन को निर्दिष्ट कर सकता है, जैसे कंसोल के लिए टेक्स्ट, एचटीएमएल के लिए अच्छे पात्र इत्यादि, और conditional text उस प्रकार के स्वरूप भिन्नता का समर्थन करता है ।

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

+0

आह, आपने मुझे इसे हराया - मुझे लगता है कि अद्यतन में एक ही निष्कर्ष है। :) – Iterator

+0

जबकि मुझे हैडली के दस्तावेज़ीकरण से प्यार है, मैं इस तथ्य का प्रशंसक नहीं हूं कि उसकी सभी सहायता फाइलें "वेबसाइट देखें" - यह मुझे समाप्त होने पर परेशान करती है जब मैं 'कुछ कार्य' करता हूं और फिर एक वेब ब्राउजर खोलें और यूआरएल को कॉपी/पेस्ट करें। 'ggplot2' के मामले में मुझे लगता है कि यह उचित है, यह देखते हुए कि ग्राफिक-निर्भर दस्तावेज कैसे है, लेकिन यह एक रास्ता नहीं है जिसे मैं नीचे जाना चाहता हूं। –

+1

मैं इसके बारे में भी प्राथमिक दस्तावेज के लिए सहमत हूं। फिर भी, मैं वर्तमान में फ़ोरम, बग ट्रैकिंग आदि के समर्थन के साथ सॉफ़्टवेयर दस्तावेज़ों के लिए लाटेक्स-सक्षम विकी का उपयोग कर रहा हूं, इसलिए एक स्थिर पीडीएफ भी एक कदम पीछे है। :) दस्तावेज होने के बारे में कुछ कहना है जो कोड से अलग विकसित होता है, जैसे फीडबैक के आधार पर उपयोग के नए उदाहरण या दस्तावेज के संशोधन की पेशकश करने में सक्षम होना। एक त्वरित संदर्भ और व्यापक दस्तावेज़ीकरण का समर्थन करने के बीच पाया जाने वाला संतुलन है। – Iterator