Jak nie uruchamiać przykładu przy użyciu roxygen2?

Piszę teraz funkcję geokodowania, która polega na posiadaniu klucza map Bing. Oczywiście wolałbym nie publikować swoich, a przykłady zawodzą bez jednego.

Jak dołączyć przykład dla użytkowników do ręcznego uruchamiania, ale nie ma go wykonywany w trakcie R CMD check?

Posługiwać się \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)
#'}

Możesz użyć \donttest{}na swoim przykładzie. Fragment zostanie dostarczony w Twojej dokumentacji, ale nie zostanie przetestowany za pomocą R CMD Check.

Więcej informacji -> ?example

#' @example
\donttest{
    2^2
    }

To 2 ^ 2 nie zostanie uruchomione, gdy będziesz biegać devtools::check()

Sprawdź to sam przed oceną. :)

Dla tych, którzy używają @example path/to/example.Rzamiast @examplestagu, możesz użyć \dontrunśrodowiska bezpośrednio w example.Rpliku. Na przykład

# 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, ja też używam roxygen2 (wersja 4.1.0). Poniżej znajduje się koniec mojego znacznika roxygen2 w mojej definicji funkcji (gctemplate) do początku części rzeczywistej.

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

Znam metodę dontrun GSee.
W mojej technice zarówno przykład liczbowy, jak i tekst wyjaśniający przykład liczbowy są komentarzami. Używam wcięć, aby odróżnić te dwa; Zauważ, że po znaku „#” jest odpowiednio 1 ostry i 2 ostre. Zawsze używam powyższej techniki "# '## / #' #" w moich pakietach. Użytkownik może wykonać operację kopiowania i wklejania za każdym razem, gdy chce przetestować funkcję. Technika ta jest - według mnie - bardziej równoległa do klasycznego bombardowania komentarzami filozofii kodowania oprogramowania.