importfrom - r roxygen2 example

¿Cómo no ejecutar un ejemplo usando roxygen2?

Question

Estoy escribiendo una función de geocodificación ahora que se basa en tener una clave de Bing Maps. Obviamente prefiero no publicar el mío, y los ejemplos fallan sin uno.

¿Cómo incluyo un ejemplo para que los usuarios ejecuten manualmente, pero no lo ejecuten durante la R CMD check ?

Answer 1

Ari, yo también uso roxygen2 (versión 4.1.0). El siguiente es el final de mi marca roxygen2 en la definición de mi función (gctemplate) hasta el comienzo de la 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){
...

Sé el método dontrun de GSee.
En mi técnica, el ejemplo numérico y el texto que explica el ejemplo numérico son comentarios. Yo uso la sangría para hacer la diferencia entre estos dos; Note que hay 1 sostenido y 2 cortantes respectivamente después de "# ''". Siempre uso la técnica "# ''## / #'' #" anterior en mis paquetes. El usuario puede copiar y pegar la operación cada vez que quiera probar la función. Esta técnica es, en mi opinión, más paralela al clásico bombardeo de comentarios de la filosofía de codificación de software.

Answer 2

Para aquellos que usan @example path/to/example.R lugar de la etiqueta @examples , puede usar el entorno /dontrun directamente en el archivo example.R . Por ejemplo

# 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

Answer 3

Puedes usar /donttest{} para tu ejemplo. El fragmento se proporcionará en su documentación, pero no se probará con el R CMD Check.

Para más información -> ?example

#'' @example
/donttest{
2^2
}

Este 2 ^ 2 no se ejecutará cuando ejecute devtools::check()

Compruébelo usted mismo antes de juzgar. :)

Answer 4

Utilice /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)
#''}