Che cosa significa "non eseguito" nelle pagine della guida di R?

Question

A volte su una pagina di guida R la frase "non eseguito" appare nei commenti. Check out questa dalla pagina di aiuto per "con()":

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**) 

Che cosa significa il "non correre" significa nel codice di esempio?

Answer 1

"non eseguire" racchiude codice che non deve essere eseguito nel example funzione (ad esempio parti di codice in termini di tempo, interazione con l'utente, ...).

vedere ad es. ?example:

Come specificato nel manuale scrittura R Estensioni, l'autore della pagina di aiuto può marcare parti degli esempi per due eccezioni regole

• 'dontrun' racchiude il codice che non dovrebbe essere gestito

• 'dontshow' racchiude il codice che è invisibile sulla pagine di aiuto, ma sarà essere eseguito sia con il pacchetto strumenti di controllo, e la funzione 'esempio()'. Questo era in precedenza "testonly" e tale modulo è ancora accettato.

Answer 2

In "Writing R Extensions" manuale, nella sezione relativa \ esempi {...} è detto che

È possibile utilizzare \ dontrun {} per il testo che deve essere mostrato solo, ma non correre, e \ dontshow {} per i comandi aggiuntivi per i test che non dovrebbero essere mostrati agli utenti, ma sarà gestito da esempio()

Quando si crea un pacchetto poi tutto il codice in \ dontrun {} chiusura è visibile in aiuto come

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

modifica: This answer era precedente.

Answer 3

C & pag dal capitolo 5.4 (R Documentazione File) dei must-to-read Creating R Packages: A Tutorial di Friedrich Leisch:

La sezione degli esempi dovrebbe contenere codice R eseguibile, e automaticamente in esecuzione il codice è parte del controllo di un pacchetto. Ci sono due speciali comandi di marcatura per gli esempi:

dontrun: Tutto dentro \ dontrun {} non viene eseguito dal test o esempio(). Ciò è utile, ad esempio, per le funzioni interattive , le funzioni accesso a Internet ecc. Non utilizzare errato per semplificare la vita a te fornendo esempi che non possono essere eseguiti .

Answer 4

Questo aggiunge \donttest{} e viene preso (testualmente) da @ hadley's R Packages.

Tuttavia, ai fini dell'illustrazione, è spesso utile includere il codice che causa un errore. \dontrun{} consente di includere il codice nell'esempio che non viene mai utilizzato. Ci sono altri due comandi speciali. \dontshow{} è gestito, ma non mostrato nella pagina di aiuto: questo può essere utile per i test informali. \donttest{} viene eseguito negli esempi, ma non eseguire automaticamente sotto controllo R CMD. Questo è utile se hai degli esempi che richiedono molto tempo per essere eseguiti. Le opzioni sono riepilogate di seguito.

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