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

【问题标题】：How do I use a variable's value inside roxygen2 documentation?如何在 roxygen2 文档中使用变量的值？
【发布时间】：2022-12-14 06:48:42
【问题描述】：

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

#' 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)
}

【问题讨论】：

从文档cran.r-project.org/web/packages/roxygen2/vignettes/rd.html 中查看@eval

标签： r roxygen2

【解决方案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

【讨论】：