在roxygen2中省略别名

时间:2015-01-03 23:14:20

标签: r roxygen2

我想使用roxygen2在单个帮助页面中记录多个功能,但我希望只有一个帮助页面的别名,即索引中列出的General。有可能吗?

一个例子:

#' General functions
#' @name General
NULL

#' @rdname Foo
foo <- function() NULL

#' @rdname Bar
bar <- function() NULL

如何从包文档索引中省略foobar别名?

此处的真实示例是用于记录不同功能的单Arithmetic别名(+-/*等。)

1 个答案:

答案 0 :(得分:0)

我自己找到了答案:你根本不导出那些并创建一个独立于功能的文档页面:

#' General functions
#'
#' @usage
#' foo()
#' bar()
#'
#' @name General
NULL

#' @export
foo <- function() NULL

#' @export
bar <- function() NULL