重定向函数的文档帮助页面

Question

在我自己的包中，我想将出现的一个函数的帮助页面重定向到另一个函数的文档。例如，当我在“is.matrix()”或“as.matrix()”上单击 F1 键时，在这两种情况下都会出现“matrix()”的帮助页面/文档。我如何使用自己的函数实现这一点？

abc <- function(data, ...) {  }
as.abc <- function(data, ...) {  }
is.abc <- function(x) {  }

我只想为 abc() 实现一个文档，而 as.abc() 和 is.abc() 的文档应该是 abc() 的文档。

提前致谢！

Answer 1

您要查找的是@rdname。参见例如http://www.iysik.com/r/roxygen2

在你的情况下，你会做

#' abc-function title
#' @rdname abc
#' @export
#' @param data Document your parameters, please!
abc <- function(data, ...) {  }

#' @rdname abc
#' @export
#' @inheritParams abc
as.abc <- function(data, ...) {  }

#' @rdname abc
#' @export
#' @param x x
is.abc <- function(x) {  }

重定向函数的文档帮助页面

Redirecting the document help page for a function

r

roxygen2