2014-10-10 4 views
5

मैं वर्तमान में R package hosted on GitHub के लिए एक दस्तावेज़ लिख रहा हूं। मैं रीडमे फ़ाइल को लिखने के लिए आर मार्कडाउन के साथ knitr का उपयोग करता हूं। RStudio में 'बुना हुआ HTML' बटन मारना एक HTML बनाता है जैसे कि मैं इसकी अपेक्षा करता हूं।गिटहब README.rmd से सभी कोड भाग प्रदर्शित करता है (बावजूद = FALSE के बावजूद)

हालांकि, उपरोक्त लिंक का पालन करते समय, आप निम्न पृष्ठ अनुभाग में जो देखते हैं उसमें GATHub के लिए README.rmd को दबाते हैं। उदाहरण के लिए, README.rmd फ़ाइल में इस प्रकार सर्वोच्च कोड हिस्सा घोषित किया जाता है:

```{r global_options, include = FALSE} 
library(knitr) 
options(width = 120) 
opts_chunk$set(fig.width = 12, fig.height = 8, fig.path = 'Figs/', 
       include = TRUE, warning = FALSE, message = FALSE) 
``` 

हालांकि, कोड की पहली पंक्ति में include = FALSE बयान बस इस मामले में नजरअंदाज कर दिया है, और कोड का टुकड़ा है कि था छुपा होना चाहिए गिटहब पेज रेफरिंग पर प्रदर्शित किया जाता है। इसके अतिरिक्त, परिणाम (उदा। plot(), head() से) opts_chunk$set(..., include = TRUE) हालांकि कल्पना नहीं किए जाते हैं।

क्या किसी को भी ऐसी ही समस्या आती है और क्या मुझे मेरी रीडमे दस्तावेज़ को सही तरीके से प्रदर्शित करने में मदद मिल सकती है, यानी RStudio इसे गिटहब पर कैसे संभालेगा?

उत्तर

9

रीडमे फ़ाइल जिसे आप जिथब पर प्रकाशित करने की कोशिश कर रहे हैं, एक सादा मार्कडाउन दस्तावेज़ होना चाहिए, यानी .md फ़ाइल और कच्चे .rmd नहीं। तो सबसे पहले आप knitr (आर के अंदर) के साथ .rmd बुनी इस प्रकार है:

knit(input="readme.rmd", output = "readme.md") #see ?knit for more options 

कि वैश्विक और हिस्सा विकल्पों स्रोत .rmd में निर्दिष्ट का मूल्यांकन करें और एक .md कि तदनुसार प्रारूप में उत्पादन और जो GitHub आसानी से प्रदान कर सकते हैं होगा।

+0

नहीं पता था कि यह इतना आसान था। धन्यवाद (: – fdetsch

+0

ओह @ शेकेन, मैं पूछना भूल गया: क्या मेरे README.rmd फ़ाइल में 'बुनाई' कथन को सीधे कार्यान्वित करने का कोई तरीका है और 'बुना हुआ HTML' मारते समय इसे स्वचालित रूप से परिवर्तित कर दिया गया है, या मुझे निष्पादित करना है यह मैन्युअल रूप से कंसोल से प्रत्येक बार? – fdetsch

+1

आर आदेश 'बुनाई()' के दौरान निष्पादित किए जाने के लिए या जब आप "बुनाई एचटीएमएल हिट करते हैं" को '.rmd' में डबल बैक कोट्स के भीतर संलग्न करके शामिल किया जा सकता है। हालांकि,' बुनाई (ब्ला ब्ला ब्लाह) '' आपके '.rmd' में आपको एक अनंत लूप में मिल सकता है :-), यह सुनिश्चित नहीं है कि मैंने कभी कोशिश नहीं की है: आप कर सकते हैं, लेकिन मुझे वांछनीय परिणाम नहीं दिखते हैं। वैकल्पिक रूप से, यदि आप Rstudio का उपयोग करते हैं, तो आप HTML उत्पादन के बाद "मार्कडाउन स्रोत फ़ाइल रखें" के लिए knitr से पूछ सकते हैं। इस विकल्प को 'उन्नत' टैब के नीचे Knitr सेटिंग्स में सक्षम किया जा सकता है (rstudio में 'बुनाई html' के बगल में थोड़ा गियर)। – shekeine

1

एक .Rmd का उपयोग कर .md उत्पन्न करने के लिए अधिक जानकारी के लिए की http://r-pkgs.had.co.nz/release.html

तुम भी devtools::use_readme_rmd() का उपयोग कर अपने पैकेज के लिए इस स्वचालित रूप से सेट DevTools हो सकता है Readme.Rmd खंड देखें।

+0

हैडली की किताब के बाद, मुझे अपने उपयोग को प्रदर्शित करने के लिए आरएमडी फ़ाइल में अपना पैकेज लोड करने में समस्या थी। दरअसल, पैकेज विकास में है, इस प्रकार मेरी मशीन पर स्थापित नहीं है और बुनाई के लिए उपलब्ध है। इस के आसपास कैसे हो? – Heisenberg

+0

'devtools :: dev_mode() 'का उपयोग करें और पैकेज स्थापित करें। आपको विगनेट बनाने के लिए पैकेज स्थापित करने की आवश्यकता है। – Jim

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