কীভাবে রোজ অক্সিজেন ব্যবহার করে উদাহরণ চালাবেন না?


96

আমি এখনই একটি জিওকোডিং ফাংশন লিখছি যা একটি বিং মানচিত্র কী থাকার উপর নির্ভর করে। স্পষ্টতই আমি আমার প্রকাশ করতাম না এবং উদাহরণগুলি ব্যতীত ব্যর্থ হত।

ব্যবহারকারীদের ম্যানুয়ালি চালানোর জন্য আমি কীভাবে একটি উদাহরণ অন্তর্ভুক্ত করব, তবে এটি কার্যকর হয়নি R CMD check?

উত্তর:


149

ব্যবহার \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)
#'}

4
এটি ডকুমেন্টেড ?exampleএবং র এক্সটেনশনগুলি
রচনায় রয়েছে

4
@ জিরোইন, আমি বিশ্বাস করি যে ট্যাগটি roxygen2তৈরি হয়েছে @example, তাই আমি মনে করি এটি একটি roxygen2সমস্যা। আমি \example{}বৈধ বলে মনে করি না - দেখুন cran.r-project.org/doc/manouts/…
জিএস দেখুন

4
বিষয়টির শিরোনাম থেকে বিচার করা যায়, প্রশ্নটি রোজিন 2 সিনট্যাক্স সম্পর্কে এবং না। সিনডাক্স সম্পর্কে?
জেরোইন

উত্তর করার জন্য ধন্যবাদ. এটি আমার পক্ষে প্রথম কাজ করে না কারণ আমি @exampleপরিবর্তে ব্যবহার করছিলাম @examples। উভয় ট্যাগ আরস্টুডিও অটো-সম্পূর্ণ মধ্যে আসে। আমি এখন খুশি.
পল রাউজিউস

4
আমি মনে করি যেটির জন্য জিজ্ঞাসা করা হচ্ছে তার সঠিক উত্তরটি ডানস্টেস্ট এবং ডনট্রুন নয়। দেখুন? উদাহরণস্বরূপ এবং স্ট্যাকওভারফ্লো . com/ প্রশ্নগুলি / ১২০৩৮১60০/২Cran.r-project.org/web/packages/rogen2/vignettes/rd.html এও দেখুন ।
জুলিয়ান কারচ

37

আপনি \donttest{}আপনার উদাহরণ ব্যবহার করতে পারেন । আপনার ডকুমেন্টেশনে স্নিপেট সরবরাহ করা হবে তবে আর সিএমডি চেক দিয়ে পরীক্ষা করা হবে না।

আরও তথ্যের জন্য -> ?example

#' @example
\donttest{
    2^2
    }

আপনি যখন রান করবেন তখন এই 2 ^ 2 চালাবে না devtools::check()

বিচার করার আগে এটি নিজেই পরীক্ষা করে দেখুন। :)


16
দেখে মনে হচ্ছে এটি ডানট্রুনের পরিবর্তে গ্রহণযোগ্য উত্তর হওয়া উচিত। থেকে? উদাহরণস্বরূপ 'দন্টস্টেস্ট এনকোলেস কোডগুলি যা সাধারণত চালানো উচিত, তবে প্যাকেজ পরীক্ষার সময় নয়' যদিও 'চালিত হওয়া উচিত নয় এমন কোডটি ডান্ট্রন করে। ড্যানট্রন থেকে ডানস্টেস্টে স্যুইচ করতে ক্রেইন রক্ষণাবেক্ষণকারীদেরও আমি একটি মন্তব্য পেয়েছি।
জুলিয়ান কারচ

4
সম্পূর্ণরূপে @ জুলিয়ান কার্লসের সাথে একমত। CRAN রক্ষণাবেক্ষণকারীদের কাছ থেকে একই প্রতিক্রিয়া পেয়েছি।
ডেভিড

11

যারা ট্যাগের @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

4
এটি আমার পক্ষে কাজ করে না (উইন 10, 64 বিট, আরএস 3.5.0.0 এ চলছে)
জেবিজে

2

এরি, আমি রক্সিজেন 2 (সংস্করণ 4.1.0) ব্যবহার করি। আসল অংশের শুরু পর্যন্ত আমার ফাংশন (gctemplate) সংজ্ঞাটিতে আমার রক্সিজেন 2 মার্ক-আপের সমাপ্তি নীচে দেওয়া হয়েছে।

#' @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 টি শার্প রয়েছে। আমি সবসময় উপরের "# '## / #' #" কৌশলটি আমার প্যাকেজগুলিতে ব্যবহার করি। যখনই সে ফাংশনটি পরীক্ষা করতে চায় ব্যবহারকারী অনুলিপি-পেস্ট অপারেশনে রেখে যায়। এই কৌশলটি হ'ল - আমার মতে - সফ্টওয়্যার কোডিং দর্শনের শাস্ত্রীয় মন্তব্য বোমা হামলার সাথে আরও সমান্তরাল।


14
আপনি যদি ব্যবহার করেন dontrun{}তবে ব্যবহারকারী কল করতে পারবেন example(myFunction, run.dontrun=TRUE), তবে আপনি যদি উদাহরণগুলি সহজভাবে মন্তব্য করেন তবে অনুলিপি / পেস্ট করা ছাড়া অন্য উদাহরণগুলি চালানোর কোনও উপায় আপনার নেই।
জিএসই
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.