Que signifie "ne pas exécuter" dans les pages d'aide R?

Question

Parfois, sur une page d’aide R, l’expression "ne pas exécuter" apparaît dans les commentaires. Découvrez ceci à partir de la page d'aide pour "with ()":

 Examples
require(stats); require(graphics)
#examples from glm:
**## Not run:** 
library(MASS)
with(anorexia, {
    anorex.1 <- glm(Postwt ~ Prewt + Treat + offset(Prewt),
                    family = gaussian)
    summary(anorex.1)
})
## End(**Not run**)
 

Que signifie le "pas exécuté" dans l'exemple de code?

Answer 1

"ne pas courir" enferme code qui ne devrait pas être exécutée dans l' example de la fonction (par exemple, temps parties de code).

voir, par exemple, ?example:

Comme détaillé dans le manuel de l'Écriture d'Extensions de R, l'auteur de la page d'aide peut balisage des pièces des exemples pour les deux exception les règles

• 'dontrun' enferme code qui ne doit pas être exécuté.

• 'dontshow' enferme code qui est invisible sur les pages d'aide, mais être utilisée à la fois par le package d'outils de vérification, et la l'exemple de()' fonction. C'était déjà testonly', et que la forme est toujours accepté.

Answer 2

Dans "l'Écriture d'Extensions de R" manuel, dans la section à propos de \exemples{...} est dit que

Vous pouvez utiliser \dontrun{} du texte qui ne doit être affiche, mais pas les exécuter, et \dontshow{} pour des commandes supplémentaires pour les tests cela ne devrait pas être démontré que les utilisateurs, mais sera exécuté par l'exemple()

Lorsque vous créez un package puis, tout le code de \dontrun{} fermeture est visible dans l'aide comme

## Not run:
...
## End(**Not run**)

edit: Cette réponse a été plus tôt.

Answer 3

Cela ajoute de la \donttest{} et est pris en compte (mot à mot) de @hadley du R Paquets.

Toutefois, pour les fins de l'illustration, il est souvent utile d'inclure le code qui provoque une erreur. \dontrun{} vous permet d'inclure du code dans l'exemple qui n'est jamais utilisé. Il y a deux autres commandes spéciales. \dontshow{} est exécuté, mais n'apparaît pas dans la page d'aide: cela peut être utile pour les tests. \donttest{} est exécuté dans les exemples, mais n'est pas exécuté automatiquement dans la R CMD check. Ceci est utile si vous avez des exemples qui prennent du temps à s'exécuter. Les options sont résumées ci-dessous.

Command      example    help       R CMD check
\dontrun{}                 x
\dontshow{}       x                          x
\donttest{}       x        x

Answer 4

C & p du Chapitre 5.4 (R Fichiers de Documentation) de la DOIT À LIRE de la Création de Packages R: Un Tutoriel par Friedrich Leisch:

Les exemples de la section doit contenir exécutable R code, et automatiquement l'exécution du code est la partie de la vérification un package. Il y a deux spéciales balisage des commandes pour les exemples:

dontrun: Tout à l'intérieur de \dontrun{} n'est pas exécutée par les tests ou exemple(). Ceci est utile, par exemple, pour fonctions interactives, des fonctions l'accès à Internet, etc.. Ne sont pas un mauvais usage de rendre la vie plus facile pour vous en donnant des exemples qui ne peuvent pas être exécutée.