如何在 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