Как мне сказать R добавить виньетку моего пакета в документацию при сборке / установке моего пакета? - PullRequest
0 голосов
/ 27 декабря 2018

Я пытаюсь добавить виньетку пакета, чтобы она отображалась в документации при использовании этих функций 1.4.0.9000 и devtools 2.0.1 в RStudio 1.1.463.Я использовал новый пакет с использованием этого и установил лицензию, а затем добавил общую виньетку:

setwd("~/Desktop")
usethis::create_package("blah")
usethis::use_gpl3_license("me")
usethis::use_vignette("a-vignette")

Я аккуратно подправил виньетку, чтобы она могла вязаться.Я закомментировал библиотечный вызов и добавил немного текста в последнюю пустую строку виньетки:

```{r setup}
#library(blah)
```

Hello World

, а затем проверил, работает ли он с помощью кнопки «Вязать», и он вяжет и отображает HTML-страницу.

Я использую вкладку «Построить» меню «Дополнительно», выбрал «Документ» и там написано:

Updating blah documentation 
Loading blah 
Documentation complete

В этой виньетке нет никаких упоминаний.Поэтому я думаю, что это работает только в папке man ...

Затем я использую кнопку "Установить и перезапустить" меню "Сборка", а затем открываю документацию пакета (в области окна пакетов), она ничего не говорит овиньетка.

Поэтому я попытался использовать:

devtools::build_vignettes()

, и это дает мне обратную связь, которая имеет смысл:

Building blah vignettes
Moving a-vignette.html, a-vignette.R to doc/
Copying a-vignette.Rmd to doc/
Building vignette index

Но снова, когда я устанавливаю и перезапускаю документациюнет упоминания о виньетке.

Итак, как мне отобразить виньетку в качестве ссылки в документации к пакету?

...