6
के साथ @example टैग का उपयोग करते समय फ़ाइलों का स्थान roxygen2 के साथ फ़ंक्शन को दस्तावेज़ करते समय उदाहरण को एक अलग फ़ाइल में रखना संभव है।roxygen2
यहाँ देखें: http://r-pkgs.had.co.nz/man.html "उदाहरण दस्तावेज में सीधे शामिल करने की बजाय, आप उन्हें अलग फ़ाइलों में डाल दिया है और उन्हें प्रलेखन में डालने के लिए @example पथ/रिश्तेदार/to/packge/जड़ उपयोग कर सकते हैं।"
और यहाँ: http://roxygen.org/roxygen2-manual.pdf
उदा
#' Add together two numbers.
#'
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @example /path/to/example/add.R
add <- function(x, y) {
x + y
}
मेरा प्रश्न है: उदाहरण आर फाइलों को संग्रहीत करने के लिए किस पथ का उपयोग किया जाना चाहिए?
'inst/example'? – jdharrison
मुझे लगता है कि पैकेज स्थापित करते समय/inst/move/move? मुझे लगता है कि इससे कोई फर्क नहीं पड़ता कि दस्तावेज पहले से ही बनाया गया है? – wannymahoots
हां 'inst/example' को' उदाहरण 'पर ले जाना चाहिए और मुझे लगता है कि आप अपने दस्तावेज़ में'/example' का संदर्भ दे सकते हैं। – jdharrison