R пакет виньетки - PullRequest
       38

R пакет виньетки

1 голос
/ 20 марта 2019

Меня немного смущает вопрос, почему в пакете R. есть несколько возможных мест для "виньеток".Я не понимаю, какие места используются для чего и когда.Например:

devtools::use_vignettes()

создает папку виньеток в корне пакета

devtools::build_vignettes() 

создает папку inst / doc, которая перемещается в корневой каталог при сборке

pkgdown::build_site()

создает папку документов.

В качестве справки: я прочитал книгу о пакетах H.Wickhams R и создал несколько пакетов, используя первый вариант, и все было хорошо.Я хотел бы, чтобы пользователи устанавливали с github, используя:

devtools::install_github(pkg,build_vignettes=TRUE)

Теперь я только начал вносить вклад в совместную разработку пакета, в котором использовались первый и третий вариант.Я заметил, что файл .rmd в папке виньеток совпадает с файлом index.html в папке документов.Копирует ли pkgdown из папки виньетки?

Также для этого пакета при установке из github (с build_vignettes = TRUE) я получаю сообщение об ошибке установки, потому что не удалось найти путь doc / index.html.Теперь, почему это случилось?

1 Ответ

2 голосов
/ 21 марта 2019

Разработка виньеток

Существует только одно место для размещения сырых виньеток, оно находится в каталоге виньеток в корне.Это место, где вы пишете свой Rmd-файл с примерами текста и кода при разработке вашего пакета.

Создание виньеток для ваших пользователей

Когда вы создаете свои виньетки, файл Rmd будет вязаным.Полученный html-файл, необработанный Rmd-файл и извлечение кода R будут тремя файлами, сохраненными в каталоге inst / doc.Это то, что будет храниться в пакете установки.Это то, что пользователи смогут читать.

{pkgdown}

{pkgdown} использует ваши Rmd-файлы из каталога виньетки для связывания html-файлов, чтобы он мог создать веб-сайт для вашего пакета.Он также создает страницу для списка функций и индекса из файла Readme, который также используется для вашего git-репозитория.Это не должно оставаться в пакете R и недоступно для пользователей.Это делается для того, чтобы представить ваш пакет в Интернете.

Заключение

Следовательно, когда вы разрабатываете, вы пишете только свою Rmd виньетку в каталоге виньеток.Остальные автоматически сохранят то, что им нужно.

...