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