Исключить функцию из руководства по пакету R

Question

Я пишу пакет R и документирую все свои функции с помощью roxygen2. Однако я не хочу, чтобы все функции появлялись в руководстве к пакету. Как я могу указать, какие функции должны появляться в руководстве по пакету, а какие нет?

Я знаю, что присвоение имени функции с ведущей точкой, например, .f <- function() вместо f <- function() это решение. Есть ли другие решения?

Answer 1

Я упустил следующую деталь в превосходной книге R пакетов Хэдли Уикхэма (в разделе об объектной документации):

@keywords keyword1 keyword2... добавляет стандартные ключевые слова. Ключевые слова являются необязательными, но если они есть, они должны быть взяты из предопределенного списка, найденного в file.path(R.home("doc"), "KEYWORDS").

Как правило, ключевые слова не так полезны, за исключением внутреннего @keywords. Использование внутреннего ключевого слова удаляет функцию из индекса пакета и отключает некоторые из их автоматических тестов. Обычно внутренние @keywords используются для функций, которые представляют интерес для других разработчиков, расширяющих ваш пакет, но не для большинства пользователей.

Итак, добавление @keywords internal из-за того, что документация по функции roxygen2 приводит к тому, что эта функция не отображается в руководстве / индексе пакета, при этом после загрузки пакета страница справки становится доступной.