Question

我正在编写一个函数的帮助，我想要第二个函数来显示相同的帮助文件。我如何在Roxygen / devtools中做到这一点？

例如，请考虑以下事项：

我们首先拥有一个包含完整帮助文件的功能

#' Plot random points
#' @param color Color of random points
#' @export
plotRandomPoints = function(color = "red"){
   plot(NA, xlim = c(0, 10), ylim = c(-2,2))
   drawRandomPoints(col = color)
}

现在我们有第二个功能，我们想要共享相同的帮助文件

#' <link to plotRandomPoints>
#' @export
drawRandomPoints = function(color = "red"){
  points(rnorm(10), col = color)
}

我们如何<link to plotRandomPoints>？

Answer 1

我相信@rdname标签是您正在寻找的。如果您将第二个代码块更改为此

#' @rdname plotRandomPoints
#' @export
drawRandomPoints = function(color = "red"){
 points(rnorm(10), col = color)
}

生成的帮助文件应包含plotRandomPoints()和drawRandomPoints()

Roxygen：默认帮助另一个功能

1 个答案: