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

Answer 2

对于 Roxygen2：

#' @rdname foo
#' @export
foo_alias <- foo