Может ли Roxygen игнорировать непользовательские функции?

Question

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

В частности, я бы предпочел, чтобы у меня не было .Rd файл всплывает, потому что я использую .onLoad() крючок в моем пакете.Эта функция уже задокументирована в base пакет, так что у меня нет причин повторно его документировать.

Answer 1

Что ж, я наконец нашел и просмотрел список Roxygen-devel по адресу R-кузница чтобы увидеть, когда это будет реализовано, и, похоже, это уже есть в версии Roxygen, которая находится на CRAN.Ключ заключается в том, чтобы указать use.Rd2=TRUE при вызове roxygenize().В этом режиме Roxygen пропустит создание документации для любых функций, которым не предшествуют комментарии Roxygen.

Answer 2

Это входит в их список дел - в следующей версии только функции с документацией roxygen будут создавать man-файлы.

Answer 3

Используйте внутреннее поле ключевого слова (т. е. @keywords internal) удалить функцию из документации и сделать ее доступной только для опытных пользователей.Источник: виньетка roxygen2.