Создайте главную страницу справки (индекс) для пакета R с помощью devtools

Я создаю пакет R с помощью devtools. Вся документация построена с использованием roxygen2. Для функций все работает нормально, но как я могу предоставить страницу справки для всего пакета, на которой перечислены все доступные функции.

В других пакетах внизу каждой страницы справки всегда есть ссылка, которая ведет на главную страницу:

Снимок экрана из пакета dplyr (пример ссылки)

Как я могу создать/связать эту индексную страницу с devtools?

РЕДАКТИРОВАТЬ: Если я получу доступ к странице справки по «? functionName», на консоли также будет напечатан следующий вывод «Использование документации по разработке для functionName». В репозитории devtools на github я нахожу функцию dev-help.R, который дает этот вывод. В его комментариях указано, что ссылки не будут работать с этой помощью для разработки.

Обратите внимание, что при этом отображается только один файл документации, поэтому ссылки на другие файлы в пакете работать не будут.

Итак, как я могу использовать обычную документацию вместо dev-help?


r package devtools roxygen2
person Malte    schedule 20.06.2016    source источник
comment
Вы пробовали это? Можно где-нибудь увидеть посылку?   -  person Vincent Bonhomme    schedule 20.06.2016
comment
По-моему, это автоматически добавляется. Вы пробовали это? Используйте 1_.   -  person J_F    schedule 20.06.2016
comment
@VincentBonhomme: я пробовал это, и он успешно создает страницу, доступ к которой можно получить через ?packageName. Однако это не решает нашу проблему, так как она не содержит всех функций (как обычная индексная страница) и не связана со всеми подстраницами функций. Пакет в настоящее время является только внутренним пакетом для нашей компании, поэтому, к сожалению, вы можете получить к нему доступ.   -  person Malte    schedule 21.06.2016
comment
@J_F: я пробовал devtools::document(.), но выдает тот же результат, что и document()   -  person Malte    schedule 21.06.2016

Ответы (1)


arrow_upward
4
arrow_downward

Решение найдено. Если у вас есть следующий рабочий процесс:

  1. create()
  2. document()
  3. build()
  4. install.packages()
  5. library(<pkg-name>)

документация будет загружена в пространство имен R в течение document(). Соответственно, более поздний вызов ?functionName будет относиться к этапу разработки документации, а не к этапу, предоставленному скомпилированным пакетом.

Таким образом, создание нового сеанса R после установки просто решает проблему!

person Malte    schedule 21.06.2016
comment
Я не мог заставить его работать с install.packages, пришлось использовать install. Ошибка: ... недоступно (для версии R 3.4.0) - person Ferroao; 13.06.2017