Как включить статические виньетки в пакет R с помощью R. rsp


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

Мне нужно, чтобы виньетки были статическими, потому что виньетки слишком долго строятся, из-за чего я не могу выполнить проверку CRAN на win-builder, если они включены динамически.

Пакет R.rsp, кажется, обеспечивает именно то, что я хочу; описано здесь: https://cran.r-project.org/web/packages/R.rsp/vignettes/R_packages-Static_PDF_and_HTML_vignettes.pdf .

Я следовал инструкциям из R.rsp. У меня есть папка vignettes, которая содержит a .html-файл с соответствующим именем .РМД файла .формат html.файл asis, как указано. У меня также есть соответствующий код в файле описания. С этими настройками я прохожу тесты CRAN на win-builder, travis и т. д. Однако, когда я загружаю пакет с github, он говорит, что нет никаких виньеток, связанных с пакетом. Я что-то упустил в пакете R. rsp? Является ли эта способность устаревшей? Нужно ли мне это делать? скопировать встроенные виньетки из папки Vignettes в папку inst / doc? (Я видел противоречивую информацию о папке vignettes против папки inst/doc).

Является ли использование чего-то вроде R. rsp::asis лучшим способом включить виньетки, которые слишком долго собираются, чтобы включить динамически? Другой метод, который я видел, заключается в том, чтобы включить папку vignettes .Rbuildignore, а затем включить примечание в файл README, сообщающее пользователям, что они могут создавать виньетки отдельно от github в порядке просмотреть их. Я также рассматриваю возможность включения ссылок в README на внешние виньетки. Это лучший подход? Что может предпочесть Крэн?

1 3

1 ответ:

Добавьте build_vignettes=TRUE к вашему вызову install_github.