Подтвердить что ты не робот

Предварительная разработка документации R

Я пишу свой первый R-пакет, используя devtools и roxygen2 в RStudio IDE. Проблема, которую я имею, связана с предварительным просмотром файлов .Rd, которые я получаю, когда я "роксигенизую" файлы .R. Я использую devtools::document() для получения файлов .Rd, но когда я пытаюсь просмотреть страницы справки, написав любой из них:

help("FunctionName")
?FunctionName

на консоли отображается сообщение "Использование документации по разработке для...", но в окне справки пустое место. Использование devtools:load_all() вызывает ту же проблему. Возможно, это связано с тем, как devtools загружает пакет в среду, но ни документ "Написание R-расширений" (с которым не следует обращаться, чтобы использовать roxygen), ни книгу "R-пакеты" Hadley Wickham обеспечивает рабочее решение.

4b9b3361

Ответ 1

В Rstudio в настройках проекта есть сгенерированная документация с элементом roxygen - проверьте это.

enter image description here

Затем нажмите Configure... и установите флажки следующим образом:

enter image description here

Теперь, каждый раз, когда вы нажимаете Ctrl + Shift + B, ваши документы будут перестраиваться, и вы можете просматривать их, нажимая на имя функции и нажимая клавишу F1 или вводя одну из следующих строк в консоли:

?my_function
help(my_function)