R 函数的别名文档

Air*_*Jab 4 documentation r

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

foo <- function(){
    do_something
}

foo_alias <- foo
Run Code Online (Sandbox Code Playgroud)

我有 'foo' 函数的文档,所以在输入时:

?foo
Run Code Online (Sandbox Code Playgroud)

我得到了创建的文档。不幸的是,它不适用于 foo_alias。当我输入:

?foo_alias
Run Code Online (Sandbox Code Playgroud)

我什么也得不到。是否有任何解决方案,以便别名函数从 foo 继承文档?

sha*_*dow 5

您应该为文档文件添加一个别名:

\name{foo}
\alias{foo}
\alias{foo_alias}
Run Code Online (Sandbox Code Playgroud)

或者,如果您使用roxygen2

#' @name foo 
foo <- function()

#' @rdname foo
foo_alias <- foo
Run Code Online (Sandbox Code Playgroud)

  • 在 `roxygen2` 中你也可以使用 `@describeIn`。 (3认同)