R Language
roxygen2

पैरामीटर

Roxygen2 के साथ एक पैकेज का दस्तावेजीकरण

Roxygen2 के साथ लेखन

roxygen2 एक पैकेज हैडली विकम द्वारा प्रलेखन की सुविधा के लिए बनाया गया है।

यह आर स्क्रिप्ट के अंदर प्रलेखन को #' शुरू होने वाली लाइनों में शामिल करने की अनुमति देता है। प्रलेखन के लिए उत्तीर्ण किए गए विभिन्न पैरामीटर @ शुरू होते हैं, उदाहरण के लिए पैकेज के निर्माता निम्नानुसार लिखेंगे:

#' @author The Author

उदाहरण के लिए, यदि हम निम्नलिखित फ़ंक्शन का दस्तावेजीकरण करना चाहते हैं:

mean<-function(x) sum(x)/length(x)

हम इस फ़ंक्शन का एक छोटा सा विवरण लिखना चाहते हैं, और निम्नलिखित के साथ मापदंडों की व्याख्या करेंगे (प्रत्येक पंक्ति को समझाया जाएगा और उसके बाद विस्तृत होगा):

#' Mean
#'
#' A function to compute the mean of a vector
#' @param x A numeric vector
#' @keyword mean
#' @importFrom base sum
#' @export
#' @examples
#' mean(1:3)
#' \dontrun{ mean(1:1e99) }
mean<-function(x) sum(x)/length(x)

• पहली पंक्ति #' Mean डॉक्यूमेंटेशन का शीर्षक है, निम्न पंक्तियाँ कॉर्पस बनाती हैं।
• फ़ंक्शन के प्रत्येक पैरामीटर को एक प्रासंगिक @param माध्यम से विस्तृत होना चाहिए। @export ने संकेत दिया कि इस फ़ंक्शन नाम को निर्यात किया जाना चाहिए, और इस प्रकार पैकेज लोड होने पर इसे कॉल किया जा सकता है।
• @keyword मदद के लिए प्रासंगिक कीवर्ड प्रदान करता है
• @importFrom इस फ़ंक्शन या आप पैकेज में उपयोग किए जाने वाले पैकेज से आयात करने के लिए सभी कार्यों को सूचीबद्ध करता है। ध्यान दें कि पैकेज का पूरा नामस्थान आयात करने का कार्य @import साथ किया जा सकता है
• उसके बाद उदाहरण @example टैग के नीचे लिखे गए हैं।
  • पैकेज का निर्माण होने पर पहले एक का मूल्यांकन किया जाएगा;
  • दूसरा नहीं - आमतौर पर लंबी संगणना को रोकने के लिए - \dontrun कमांड के कारण।

प्रलेखन का निर्माण

दस्तावेज़ का उपयोग devtools::document() का उपयोग करके बनाया जा सकता है devtools::document() । यह भी ध्यान दें कि devtools::check() स्वचालित रूप से एक दस्तावेज बनाएगा और चेतावनी के रूप में कार्यों के प्रलेखन में गुम तर्कों की रिपोर्ट करेगा।