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