如何在 roxygen2 文档中使用变量的值？

Question

我有一个函数，其参数只能采用某些值。 我想在文档中列出可能的值。

#' Example function
#' 
#' @param x Character, possible values are "a", "b", and "c".
foo <- function(x = c("a", "b", "c")) {
  x <- match.arg(x)
}

我想只定义一次列表，然后在文档和函数体中都使用它，所以我只需要编写一次。

这是一个不起作用的大纲，但显示了这个想法。

x_values <- c("a", "b", "c")
#' Example that doesn't work
#' 
#' @param x Character, possible values are {x_values}.
foo <- function(x = x_values) {
  x <- match.arg(x)
}

Answer 1

您可以将代码放在以r开头的反引号中。

#' @param x Character, possible values are `r toString(x_values)`.
foo <- function(x = x_values) {
  x <- match.arg(x)
}

见： https ://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html