R函数的别名文档

jmp7cifd 于 2023-05-11 发布在其他

关注(0)|答案(2)|浏览(94)

我在研究R包。我以这种方式为一些函数设置别名：

foo <- function(){
    do_something
}

foo_alias <- foo

我有'foo'函数的文档，所以当键入时：

?foo

我得到创建的文档。不幸的是，它不适用于foo_alias。当我键入时：

?foo_alias

我什么都没得到。有没有什么解决方案，让alias函数继承foo的文档？

2条答案

您应该在文档文件中添加别名：

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

或者如果使用roxygen2：

#' @name foo 
foo <- function()

#' @rdname foo
foo_alias <- foo

对于Roxygen2：

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