R roxygen2: не показывать функцию в списке

Question

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

Я использую roxygen2 для пакета CRAN и пытаюсь добиться следующего:

Существует функция с именем my.function, имя функции которой я хочу заменить на my_function.

Я хочу сделать это постепенно - поэтому в течение некоторого времени имена обеих функций будут доступны.

Для первого шага я бы хотел получить следующее:

1. Если пользователь явно вызывает ?my.function, он должен обратиться к документации по функции my.function (или к документации по my_function)

2. Но если пользователь вызывает help(package="myPackage") my.function, он не должен появиться в списке функций

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

Как я могу это сделать?

Я экспериментировал с комбинациями следующих тегов кислорода:

@noRd
@alias
@describeIn
@rdname

Но я не смог достичь желаемого результата. Я спрашиваю конкретно о части документации roxgen2, а не о переопределении функции в R в целом.

Answer 1

Вы можете отключить перечисление функций в руководстве по пакету, добавив @keywords internal к комментариям roxygen (см., Например, Документация по объекту в разделе R пакетов ), но, как уже упоминалось Хонг Ой, вероятно, правильный способ - отказаться от my.function (см. раздел Выпуск пакета из R пакетов ).