Comment ne pas exécuter un exemple d'utilisation de roxygen2?
Je suis en train d'écrire un la fonction de géocodage droit maintenant, qui s'appuie sur une Clé Bing Maps. Évidemment, je préfère ne pas publier le mien, et les exemples de l'échec sans un.
Comment puis-je inclure un exemple pour les utilisateurs d'exécuter manuellement, mais de ne pas l'avoir exécuté au cours de R CMD check
?
Vous devez vous connecter pour publier un commentaire.
Utilisation
\dontrun{}
?example
et Écrit R Extensions@examples
mais pas pour@example
.roxygen2
fait le@example
tag, donc je pense que c'est unroxygen2
problème. Je ne pense pas que\example{}
est valide -- voir cran.r-project.org/doc/manuals/...@example
au lieu de@examples
. Les deux marques viennent dans RStudio de l'auto-complétion. Je suis heureux maintenant.@example
, vous pouvez toujours utiliserdontrun{}
à l'intérieur du fichier de l'exemple. mise en forme de plusieurs lignes de code dans les commentaires ne fonctionne pas bien, voir ma réponse sur la question connexe.Vous pouvez utiliser
\donttest{}
à votre exemple. L'extrait de code sera fourni dans votre documentation, mais ne pas faire le test avec la R CMD Check.Pour plus d'info -->
?example
Ce 2^2 n'obtiendrez pas s'exécuter lorsque vous exécutez
devtools::check()
Faire vérifier par vous même avant de juger. 🙂
Pour ceux qui sont à l'aide de
@example path/to/example.R
au lieu de la@examples
balise, vous pouvez utiliser le\dontrun
environnement directement dans leexample.R
fichier. Par exempleAri, j'utilise aussi roxygen2 (version 4.1.0). Ce qui suit est la fin de mon roxygen2 mark-up dans ma fonction (gctemplate) de la définition jusqu'au début de la partie réelle.
Je sais GSee du dontrun méthode.
Dans ma technique, l'exemple numérique et le texte de l'explication de l'exemple numérique sont à la fois des commentaires. J'utilise l'indentation de faire la différence entre ces deux; Avis il y a 1 sharp et 2 objets tranchants, respectivement, après "#'". J'utilise toujours le dessus "#' ## /#' #" technique dans mes paquets. L'utilisateur est laissé à copier-coller à chaque fois qu'il veux tester la fonction. Cette technique est - selon moi - est plus parallèle classique avec le commentaire de bombardement du logiciel de codage de la philosophie.
dontrun{}
, puis l'utilisateur peut appelerexample(myFunction, run.dontrun=TRUE)
, alors que si vous mettez simplement en commentaire les exemples, vous n'avez aucun moyen d'exécuter les exemples autres que de copier/coller.