省略 roxygen2 中的别名
Omit aliases in roxygen2
我想使用 roxygen2
在单个帮助页面中记录多个函数,但我只想为帮助页面设置一个别名,即索引中列出的 General
。可能吗?
一个例子:
#' General functions
#' @name General
NULL
#' @rdname Foo
foo <- function() NULL
#' @rdname Bar
bar <- function() NULL
如何从包文档索引中省略 foo
和 bar
别名?
这里的真实示例是单个 Arithmetic
别名,用于记录不同的函数(+
、-
、/
、*
等)。
我自己找到了答案:你只是不导出那些并制作一个独立于功能的文档页面:
#' General functions
#'
#' @usage
#' foo()
#' bar()
#'
#' @name General
NULL
#' @export
foo <- function() NULL
#' @export
bar <- function() NULL
我想使用 roxygen2
在单个帮助页面中记录多个函数,但我只想为帮助页面设置一个别名,即索引中列出的 General
。可能吗?
一个例子:
#' General functions
#' @name General
NULL
#' @rdname Foo
foo <- function() NULL
#' @rdname Bar
bar <- function() NULL
如何从包文档索引中省略 foo
和 bar
别名?
这里的真实示例是单个 Arithmetic
别名,用于记录不同的函数(+
、-
、/
、*
等)。
我自己找到了答案:你只是不导出那些并制作一个独立于功能的文档页面:
#' General functions
#'
#' @usage
#' foo()
#' bar()
#'
#' @name General
NULL
#' @export
foo <- function() NULL
#' @export
bar <- function() NULL