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

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

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

Справка ggplot2

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


r devtools roxygen2 ggplot2 r-package
person GegznaV    schedule 27.02.2016    source источник
comment
Хороший вопрос! Я думаю, исходный код пакетов мог бы дать ответ (если его здесь никто не знает).   -  person R Yoda    schedule 27.02.2016
comment
Насколько я знаю, эти индексные файлы генерируются автоматически. По крайней мере, в моих пакетах они всегда есть, но я их никогда не пишу. Я всегда думал, что эти буквы добавляются автоматически, как только список функций становится достаточно длинным. Но я могу ошибаться.   -  person Stibu    schedule 27.02.2016
comment
Я изучил структуру нескольких пакетов на GitHub, но пока не нашел, как сделать этот алфавитный указатель.   -  person GegznaV    schedule 27.02.2016
comment
@Stibu Сколько функций в вашем пакете, в котором есть индекс с разделами? Интересно, сколько их должно быть включено, чтобы были эти разделы.   -  person GegznaV    schedule 04.03.2016

Ответы (3)


arrow_upward
2
arrow_downward

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

1.1.4 ИНДЕКС-файл

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

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

person IRTFM    schedule 27.02.2016
comment
Я нашел эту папку html в установленной версии моего пакета, но я так и не понял, как делать разделы. Отвечает ли функция tools::Rdindex() за создание файла HTML с индексом при установке пакета? - person GegznaV; 04.03.2016

arrow_upward
1
arrow_downward

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

person MrFlick    schedule 22.06.2021

arrow_upward
0
arrow_downward

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

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

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

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

person user2554330    schedule 22.06.2021