solicita - ¿Qué significa "no ejecutar" en las páginas de ayuda R?

porque mi computadora bloquea java

Question

A veces, en una página de ayuda de R aparece la frase "no ejecutar" en los comentarios. Mira esto desde la página de ayuda para "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**)

¿Qué significa "no ejecutar" en el código de ejemplo?

Answer 1

"no ejecutar" incluye un código que no debe ejecutarse en la función de example (por ejemplo, piezas de código que consumen mucho tiempo, interacción del usuario, ...).

ver por ?example :

Como se detalla en el manual Writing R Extensions , el autor de la página de ayuda puede marcar partes de los ejemplos para dos reglas de excepción

• ''dontrun'' incluye un código que no debe ejecutarse.

• ''dontshow'' incluye código que es invisible en las páginas de ayuda, pero que se ejecutará tanto mediante las herramientas de comprobación del paquete como con la función ''example ()''. Esto fue previamente ''testonly'', y esa forma aún se acepta.

Answer 2

C y p del Capítulo 5.4 (Archivos de documentación R) de los paquetes de creación de R que DEBE LEER : un tutorial de Friedrich Leisch:

La sección de ejemplos debe contener código R ejecutable, y ejecutar automáticamente el código es parte de verificar un paquete. Hay dos comandos de marcado especiales para los ejemplos:

dontrun : todo dentro / dontrun {} no se ejecuta con las pruebas o el ejemplo (). Esto es útil, por ejemplo, para funciones interactivas, funciones que acceden a Internet, etc. No lo use mal para hacerle la vida más fácil al dar ejemplos que no se pueden ejecutar.

Answer 3

En el manual "Writing R Extensions" , en la sección about / examples {...} se dice que

Puede usar / dontrun {} para el texto que solo se debe mostrar, pero no para ejecutar, y / dontshow {} para obtener comandos adicionales para las pruebas que no se deben mostrar a los usuarios, pero se ejecutarán con el ejemplo ()

Cuando construyes un paquete, todo el código en el cierre / dontrun {} es visible en la ayuda como

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

editar: Esta respuesta fue anterior.

Answer 4

Esto agrega /donttest{} y se toma (textualmente) de los paquetes R de @ hadley.

Sin embargo, para fines de ilustración, a menudo es útil incluir código que causa un error. /dontrun{} permite incluir código en el ejemplo que nunca se usa. Hay otros dos comandos especiales. /dontshow{} se ejecuta, pero no se muestra en la página de ayuda: esto puede ser útil para pruebas informales. /donttest{} se ejecuta en ejemplos, pero no se ejecuta automáticamente en R CMD check. Esto es útil si tiene ejemplos que tardan mucho tiempo en ejecutarse. Las opciones se resumen a continuación.

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