Как получить доступ к семейной принадлежности функции пакета R

Я пытаюсь создать свой первый пакет R. Погуглил, но ничего конкретного по моему вопросу не нашел.

В руководстве по roxygen написано

@family имя семейства Автоматически добавляет см. также перекрестные ссылки между всеми функциями в семействе. Функция может принадлежать нескольким семействам.

Как получить доступ к семейным функциям? В документации после добавления моего @family text ничего не появляется...


person uncool    schedule 31.08.2015    source источник


Ответы (1)


Из книги Хэдли @family должно быть во множественном числе.

Если у вас есть семейство связанных функций, где каждая функция должна быть связана со всеми другими функциями в семействе, используйте @family. Значение @family должно быть во множественном числе.

Например, вместо @family text вам может понадобиться показать @family some text.

Кроме того, один и тот же тег @family должен быть добавлен к нескольким функциям. Например, в пакете devtools пара функций ?devtools::dev-example и ?devtools::run-examples имеют тег

#' @family example functions

В разделе См. также есть ссылки друг на друга.

person Whitebeard    schedule 31.08.2015