R Language
मेटा: प्रलेखन दिशानिर्देश
खोज…
टिप्पणियों
R टैग डॉक्स के संपादन पर चर्चा करने के लिए, R चैट पर जाएँ।
अच्छे उदाहरण बना रहे हैं
प्रलेखन में प्रश्नोत्तर के लिए अच्छे उदाहरण बनाने के लिए अधिकांश मार्गदर्शन।
इसे न्यूनतम करें और बिंदु पर पहुंचें। जटिलताओं और विषाद प्रतिकारक हैं।
दोनों काम कोड और गद्य इसे समझा शामिल करें। न ही अपने दम पर पर्याप्त है।
डेटा के लिए बाहरी स्रोतों पर निर्भर न रहें। यदि संभव हो तो डेटा जेनरेट करें या डेटासेट लाइब्रेरी का उपयोग करें:
library(help = "datasets")
डॉक्स के संदर्भ में कुछ अतिरिक्त विचार हैं:
जैसे डॉक्स में निर्मित का संदर्भ लें
?data.frameजब भी प्रासंगिक है। SO डॉक्स अंतर्निहित डॉक्स को बदलने का प्रयास नहीं है। यह सुनिश्चित करना महत्वपूर्ण है कि नए आर उपयोगकर्ता जानते हैं कि अंतर्निहित डॉक्स मौजूद हैं और साथ ही उन्हें कैसे खोजना है।ऐसी सामग्री को स्थानांतरित करें जो रिमार्क्स अनुभाग में कई उदाहरणों पर लागू होती है।
अंदाज
संकेतों
यदि आप चाहते हैं कि आपका कोड कॉपी-पेस्ट करने योग्य हो, तो प्रत्येक नई पंक्ति की शुरुआत में R> , > , या + जैसे संकेत हटा दें। कुछ डॉक्स लेखक कॉपी-पेस्ट करना आसान नहीं बनाना पसंद करते हैं, और यह ठीक है।
कंसोल आउटपुट
कंसोल आउटपुट को कोड से स्पष्ट रूप से अलग किया जाना चाहिए। आम दृष्टिकोण में शामिल हैं:
- इनपुट पर संकेत शामिल करें (जैसा कि कंसोल का उपयोग करते समय देखा गया है)।
-
#या##प्रत्येक पंक्ति शुरू करने के साथ, सभी आउटपुट पर टिप्पणी करें। - इनपुट से आउटपुट स्टैंड आउट बनाने के लिए प्रमुख
[1]पर भरोसा करते हुए प्रिंट करें। - कोड और कंसोल आउटपुट के बीच एक रिक्त रेखा जोड़ें।
असाइनमेंट
= और <- आर ऑब्जेक्ट असाइन करने के लिए ठीक हैं। कोड लिखने से बचने के लिए उचित रूप से सफेद स्थान का उपयोग करें, जो कि x<-1 रूप में पार्स करना मुश्किल है ( x <- 1 और x < -1 बीच अस्पष्ट)
कोड टिप्पणियाँ
कोड के उद्देश्य और कार्य की व्याख्या करना सुनिश्चित करें। इस स्पष्टीकरण को गद्य में या कोड टिप्पणियों में होना चाहिए, इस पर कोई कठिन और तेज़ नियम नहीं है। गद्य अधिक पठनीय हो सकता है और अधिक स्पष्टीकरण के लिए अनुमति देता है, लेकिन कोड टिप्पणियां आसान कॉपी-पेस्टिंग के लिए बनाते हैं। दोनों विकल्पों को ध्यान में रखें।
धारा
कई उदाहरणों को अनुभागों की आवश्यकता नहीं होने के लिए पर्याप्त छोटा है, लेकिन यदि आप उनका उपयोग करते हैं, तो एच 1 से शुरू करें।
