如何解决重定向函数的文档帮助页面
在我自己的包中,我想将一个函数的帮助页面重定向到另一个函数的文档。例如,在这两种情况下,当我在“is.matrix()”或“as.matrix()”上单击 F1 键时,会出现“matrix()”的帮助页面/文档。我如何用自己的函数实现这一点?
abc <- function(data,...) { }
as.abc <- function(data,...) { }
is.abc <- function(x) { }
我只想为 abc() 实现一个文档,而为 as.abc() 和 is.abc() 实现的文档应该是为 abc() 实现的文档。
提前致谢!
解决方法
您正在寻找的是 @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) { }
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。