Документация по алиасам функций R

Question

Я работаю над пакетом R. Я установил псевдонимы для некоторых функций таким образом:

foo <- function(){ 
    do_something 
} 

foo_alias <- foo 

У меня есть документация для функции «Foo», поэтому при вводе:

?foo 

Я получаю созданную документацию. К сожалению, это не работает для foo_alias. Когда я печатаю:

?foo_alias 

Я ничего не получаю. Есть ли решение для этого, чтобы функция псевдонима наследовала документацию из foo?

Answer 1

Вы должны добавить псевдоним в файл документации:

\name{foo} 
\alias{foo} 
\alias{foo_alias} 

Или, если вы используете roxygen2:

#' @name foo 
foo <- function() 

#' @rdname foo 
foo_alias <- foo