Что означает "не работает" на страницах справки R?

Иногда на странице справки R в комментариях появляется фраза "не запускается". Проверьте это на странице справки для "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**)

Что означает "не работает" в примере кода?

ОТВЕТЫ

Ответ 1

"не запускать" заключает в себе код, который не должен выполняться в функции example (например, время, затрачиваемое на части кода, взаимодействие с пользователем,...).

см., например, ?example:

Как подробно описано в руководстве "Написание R-расширений", автор страница справки может разметки частей примеров для двух исключений правила

  • 'dontrun' содержит код, который не должен запускаться.

  • 'dontshow' включает код, невидимый на страницах справки, но будет  запускаться как с помощью инструментов проверки пакетов, так и с  'example()'. Это было ранее "testonly", и  эта форма все еще принимается.

Ответ 2

В "Написание R-расширений" в разделе о \examples {...} сказано, что

Вы можете использовать \dontrun {} для текста, который должен отображаться, но не запускаться, и \dontshow {} для дополнительных команд для тестирования, которые не должны отображаться для пользователей, но будут выполняться примером()

Когда вы создаете пакет, весь код в закрытии \dontrun {} отображается в справке как

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

edit: Этот ответ был ранее.

Ответ 3

Это добавляет \donttest{} и берется (дословно) из @hadley R пакетов.

Однако в целях иллюстрации часто бывает полезно включить код, вызывающий ошибку. \dontrun{} позволяет включить код в пример, который никогда не используется. Есть еще две специальные команды. \dontshow{} запускается, но не отображается на странице справки: это может быть полезно для неофициальных тестов. \donttest{} запускается в примерах, но не выполняется автоматически при проверке R CMD. Это полезно, если у вас есть примеры, которые требуют много времени для запуска. Ниже приведены варианты.

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

Ответ 4

C и p из главы 5.4 (файлы документации R) MUST-TO-READ Создание R-пакетов: учебник от Фридриха Лейша

Раздел примеров должен содержать исполняемый R-код и автоматически запуск кода является частью проверки пакет. Есть два специальных команды разметки для примеров:

dontrun: все внутри \dontrun {} не выполняется испытаниями или пример(). Это полезно, например, для интерактивные функции, функции доступа к Интернету и т.д. неправильно использовать его, чтобы облегчить вам жизнь давая примеры, которые не могут быть выполняется.