Wie kann ich kein Beispiel mit roxygen2 ausführen?

Ich schreibe gerade eine Geokodierungsfunktion , die auf einem Bing Maps-Schlüssel beruht. Natürlich möchte ich meine lieber nicht veröffentlichen, und die Beispiele scheitern ohne eine.

Wie füge ich ein Beispiel hinzu, das Benutzer manuell ausführen können, aber währenddessen nicht ausführen lassen R CMD check?

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

Sie können \donttest{}zu Ihrem Beispiel verwenden. Das Snippet wird in Ihrer Dokumentation bereitgestellt, jedoch nicht mit dem R CMD Check getestet.

Für weitere Informationen -> ?example

#' @example
\donttest{
    2^2
    }

Diese 2 ^ 2 werden nicht ausgeführt, wenn Sie ausgeführt werden devtools::check()

Überprüfen Sie es selbst, bevor Sie urteilen. :) :)

Für diejenigen, die @example path/to/example.Ranstelle des @examplesTags verwenden, können Sie die \dontrunUmgebung direkt in der example.RDatei verwenden. Beispielsweise

# 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, ich benutze auch roxygen2 (Version 4.1.0). Das Folgende ist das Ende meines roxygen2-Markups in meiner Funktionsdefinition (gctemplate) bis zum Beginn des Realteils.

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

Ich kenne die Dontrun-Methode von GSee.
In meiner Technik sind das numerische Beispiel und der Text, der das numerische Beispiel erklärt, beide Kommentare. Ich benutze Einrückungen, um zwischen diesen beiden zu unterscheiden. Beachten Sie, dass nach "# '" jeweils 1 scharfe und 2 scharfe Punkte angezeigt werden. Ich verwende in meinen Paketen immer die obige "# '## / #' #" Technik. Der Benutzer kann kopieren und einfügen, wann immer er die Funktion testen möchte. Diese Technik ist meiner Meinung nach eher parallel zum klassischen Kommentarbombardement der Software-Codierungsphilosophie.