roxygen2链全函数族

Question

在roxygen2包的@ this标记中，一个通常链接到另一个函数，如这个@seealso \code{\link{functionName}}。我想从一个函数链接到一个函数族(使用@family标记创建)。所以有点像@seealso \code{\link{@family familyName}}。关键的是，我想要联系的功能不是家庭的一部分。除了将每个家庭成员单独联系在一起之外，这是否有可能？

Answer 1

我能想到的最优雅的解决方案是使用模板。在man-roxygen/seealso/目录中，我将创建类似于familyName.R的内容如下：

#' @seealso Functions from the family: [`a()`], [`b()`], and [`c()`].

然后，若要将此模板包含在不属于家族的函数的文档中，请使用：

#' Do R
#' 
#' This function does some R.
#' 
#' @template seealso/familyName
#' 
#' @export
d <- function() {}

不幸的是，这不是理想的解决方案，但在某种程度上它更容易管理。至少，在这个模板文件中添加和删除家族函数比在R/目录中查找所有引用更容易。