Como não executar um exemplo usando roxygen2?

Estou escrevendo uma função de geocodificação agora que depende de ter uma chave do Bing Maps. Obviamente, prefiro não publicar o meu, e os exemplos falham sem um.

Como posso incluir um exemplo para que os usuários executem manualmente, mas não executem durante R CMD check?

Usar \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)
#'}

Você pode usar o \donttest{}seu exemplo. O snippet será fornecido em sua documentação, mas não será testado com o R CMD Check.

Para mais informações -> ?example

#' @example
\donttest{
    2^2
    }

Este 2 ^ 2 não será executado quando você correr devtools::check()

Verifique você mesmo antes de julgar. :)

Para quem está usando no @example path/to/example.Rlugar da @examplestag pode-se usar o \dontrunambiente diretamente no example.Rarquivo. Por exemplo

# 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

Ari, também uso o roxygen2 (versão 4.1.0). A seguir está o fim da minha marcação roxygen2 na definição da minha função (gctemplate) até o início da parte real.

#' @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){
...

Eu conheço o método dontrun do GSee.
Na minha técnica, o exemplo numérico e o texto explicando o exemplo numérico são ambos comentários. Eu uso recuo para fazer a diferença entre os dois; Observe que há 1 sustenido e 2 sustenidos respectivamente após "# '". Eu sempre uso a técnica "# '## / #' #" acima em meus pacotes. O usuário pode executar a operação de copiar e colar sempre que quiser testar a função. Esta técnica é - a meu ver - mais paralela com o clássico bombardeio de comentários da filosofia de codificação de software.