Как включить статические виньетки в R Package с помощью R.rsp - PullRequest
0 голосов
/ 15 сентября 2018

Я хотел бы включить статические виньетки в свой пакет 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, которая содержит файл .html с соответствующим файлом .Rmd и файлом .html.asis, как указано.У меня также есть соответствующий код в файле DESCRIPTION.С этими настройками я прохожу тесты CRAN на win-builder, travis и т. Д. Однако, когда я загружаю пакет с github, он говорит, что с пакетом не связано никаких виньеток.Я что-то упускаю из пакета R.rsp?Эта возможность устарела?Нужно ли копировать встроенные виньетки из папки Vignettes в папку inst / doc?(Я видел противоречивую информацию о папке виньетки против папки inst / doc).

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

1 Ответ

0 голосов
/ 15 сентября 2018

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

...