कैसे roxygen2 का उपयोग कर एक उदाहरण नहीं चलाने के लिए?

Question 1

मैं अभी एक जियोकोडिंग फ़ंक्शन लिख रहा हूं जो बिंग मैप्स कुंजी पर निर्भर करता है। जाहिर है कि मैं उन्हें प्रकाशित नहीं करना चाहता, और उदाहरण एक के बिना विफल हो जाते हैं।

मैं उपयोगकर्ताओं को मैन्युअल रूप से चलाने के लिए एक उदाहरण कैसे शामिल करूं, लेकिन क्या इसे निष्पादित नहीं किया गया है R CMD check?

Question 2

उपयोग \dontrun{}

#'@examples
#'\dontrun{
#'geocode("3817 Spruce St, Philadelphia, PA 19104")
#'geocode("Philadelphia, PA")
#'dat <- data.frame(value=runif(3),address=c("3817 Spruce St, Philadelphia, PA 19104","Philadelphia, PA","Neverneverland"))
#'geocode(dat)
#'}

Question 3

आप \donttest{}अपने उदाहरण के लिए उपयोग कर सकते हैं । स्निपेट आपके प्रलेखन में प्रदान किया जाएगा, लेकिन आर सीएमडी चेक के साथ परीक्षण नहीं किया जाएगा।

अधिक जानकारी के लिए -> ?example

#' @example
\donttest{
    2^2
    }

जब आप दौड़ेंगे तो यह 2 ^ 2 नहीं चलेगा devtools::check()

जज करने से पहले खुद इसकी जांच करें। :)

Question 4

उन लोगों के लिए जो टैग के @example path/to/example.Rबजाय उपयोग कर रहे हैं @examplesआप फ़ाइल \dontrunमें सीधे पर्यावरण का उपयोग कर सकते हैं example.R। उदाहरण के लिए

# example.R
\dontrun{
# this is a long running example
for(i in seq(1, 1e5)) { lm(mpg ~ wt, data = mtcars) }
}

# some other shorter example
2 + 2

Question 5

अरी, मैं भी roxygen2 (संस्करण 4.1.0) का उपयोग करता हूं। वास्तविक भाग की शुरुआत तक मेरे roxygen2 मार्क-अप का मेरे फ़ंक्शन (gctemplate) परिभाषा में अंत है।

#' @examples
#' ## List all G-causalities in a VAR system of 5 variables that will be searched in the pattern of 1 
#' ## causer (like-independent) variable and 2 like-dependents conditional on 5-(1+2)=2 of the remaining 
#' ## variable(s) in the system. Variables are assigned to numbers 1 to nvars. 
#' ## "1 2 5 3 4" in the resulting line of gctemplate is to indicate the 
#' ## (conditonal, partial, etc.) G-causality from variable 1 to variables 2 and 5 
#' ## conditonal on variables 3 and 4.
#' # gctemplate(5,1,2)
#' ## The number of all G-causalities to be searched in the above pattern.
#' #dim(gctemplate(5,1,2))[[1]]
#' @importFrom combinat combn
#' @export
gctemplate <- function(nvars, ncausers, ndependents){
...

मुझे पता है कि जीएसई का डिटरन विधि है।
मेरी तकनीक में, संख्यात्मक उदाहरण और संख्यात्मक उदाहरण की व्याख्या करने वाले पाठ दोनों टिप्पणियाँ हैं। मैं इन दोनों के बीच अंतर करने के लिए इंडेंटेशन का उपयोग करता हूं; सूचना "#" के बाद क्रमशः 1 तेज और 2 शार्प हैं। मैं हमेशा अपने पैकेजों में उपरोक्त "# # # # / #" # तकनीक का उपयोग करता हूं। जब भी वह फ़ंक्शन का परीक्षण करना चाहता है, तब उपयोगकर्ता को कॉपी-पेस्ट ऑपरेशन के लिए छोड़ दिया जाता है। यह तकनीक है - मेरे अनुसार - सॉफ्टवेयर कोडिंग दर्शन की शास्त्रीय टिप्पणी बमबारी के साथ और अधिक समानांतर।