How to not run an example using roxygen2?

Question

I\'m writing a geocoding function right now that relies on having a Bing Maps Key. Obviously I\'d rather not publish mine, and the examples fail without one.

How do

Answer 1

For those who are using @example path/to/example.R instead of the @examples tag you can use the \dontrun environment directly in the example.R file. For example

# 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