Добавьте разделы в справку / документацию пакета R

Question

Немного R пакеты (например, ggplot2, dplyr,devtools и т. д.) имеют разделы в справке / документации, озаглавленные в алфавитном порядке, и панель ссылок на эти разделы (обозначены красными стрелками на рисунке ниже). Другие пакеты (например, RcmdrMiscне имеет

Как я могу добавить эти элементы в май R помощь пакета?

я использую roxygen2 для документации.

Answer 1

В файле Writing R Extensions (входит в каждую копию R из CRAN) есть небольшой раздел, касающийся файла INDEX:

1.1.4 Файл INDEX

Необязательный файл INDEX содержит строку для каждого достаточно интересного объекта в пакете, давая его имя и описание (такие функции, как методы печати, обычно не вызываемые явно, могут не включаться). Обычно этот файл отсутствует, и соответствующая информация автоматически генерируется из источников документации (используя tools::Rdindex()) при установке из источника.

Когда пакеты имеют индексный файл, HTML-код находится в html папка.

Answer 2

Индексная страница справки автоматически создается R при установке пакета. Но обратите внимание, что алфавитный указатель создается только тогда, когда на странице указателя больше 100 элементов. В настоящее время нет возможности изменить это поведение. Я обнаружил, что в коде для установки пакетов

Answer 3

Как говорят @iRTFM и @MrFlick, вы не можете повлиять на индекс, отображаемый R. Однако, если вы используете pkgdownpackage для создания веб-страницы пакета, у вас есть полный контроль над основным индексом для страниц справки. Например, см.

https://ggplot2.tidyverse.org/reference/index.html

Описание того, как был указан этот индекс, приведено на странице справки. ?pkgdown::build_reference, который отображается здесь:

https://pkgdown.r-lib.org/reference/build_reference.html