Roxygen：默认帮助另一个功能答案

【问题标题】：Roxygen: Defaulting help to another functionRoxygen：默认帮助另一个功能
【发布时间】：2018-01-06 21:37:38
【问题描述】：

我正在为一个函数编写帮助，我想要第二个函数来显示相同的帮助文件。如何在 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>？

【问题讨论】：

@inherit source_function will inherit parameters, return, references, description, details, sections, and seealso from source_function().cran.r-project.org/web/packages/roxygen2/vignettes/rd.html

标签： r devtools roxygen2

【解决方案1】：

我相信@rdname 标签就是您要找的。如果你把第二个代码块改成这个

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

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

【讨论】：