Избегайте проверки примеров "\ notrun" при использовании R CMD check - PullRequest
1 голос
/ 25 марта 2020

Когда я запускаю R CMD check на моем пакете ( Ctrl + Shift + E в RStudio), он также проверяет, выполняются ли мои примеры без ошибок.

К сожалению, есть некоторые примеры, которые не следует запускать в этом контексте, поскольку они включают внешние файлы, которые важны для понимания, но не для тестирования. Они заключены в \dontrun{} в заголовке ROxygen.

Я знаю, что мог бы использовать --no-examples в R CMD check дополнительных опциях (RStudio> Build> More> Configure Build Tools), но это проверило бы вообще никакого примера, а это не то, что я хочу.

Вместо этого я бы хотел, чтобы R CMD check запустил devtools::run_examples(run=FALSE, fresh = T), чтобы примеры в \dontrun{} не запускались. Эта команда отлично работает в консоли.

Как я могу настроить R CMD check в RStudio таким образом?

1 Ответ

0 голосов
/ 25 марта 2020

Иногда при изменении документации, например примеров, старые файлы остаются в папке man вашего пакета. Вот почему после изменения, такого как упаковка примеров в \dontrun{}, имеет смысл очистить каталог. Вы можете сделать это с помощью roxygen2, запустив:

roxygen2::roxygenise(clean = TRUE)
...