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
?
?example
und Schreiben von R-Erweiterungenroxygen2
das hat das@example
Tag gemacht, also denke ich, dass es einroxygen2
Problem ist. Ich denke nicht, dass\example{}
es gültig ist - siehe cran.r-project.org/doc/manuals/…@example
stattdessen verwendet habe@examples
. Beide Tags werden in RStudio automatisch vervollständigt. Ich bin jetzt glücklich.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
Diese 2 ^ 2 werden nicht ausgeführt, wenn Sie ausgeführt werden
devtools::check()
Überprüfen Sie es selbst, bevor Sie urteilen. :) :)
quelle
Für diejenigen, die
@example path/to/example.R
anstelle des@examples
Tags verwenden, können Sie die\dontrun
Umgebung direkt in derexample.R
Datei verwenden. Beispielsweisequelle
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.
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.
quelle
dontrun{}
, kann der Benutzer aufrufenexample(myFunction, run.dontrun=TRUE)
, während Sie, wenn Sie die Beispiele einfach auskommentieren, keine andere Möglichkeit haben, die Beispiele auszuführen, als sie zu kopieren / einzufügen.