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

You can use \donttest{} to your example. The snippet will be provided in your documentation, but won't get tested with the R CMD Check.

For more info --> ?example

#' @example
\donttest{
    2^2
    }

This 2^2 won't get run when you run devtools::check()

Do check it yourself before judging. :)