我有一个函数,它的参数只能取某些值。我想在文档中列出可能的值。
#' 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)
}
型
1条答案
按热度按时间oprakyz71#
您可以将代码放在以
r
开头的反引号中。字符串
一定要有
型
在你的描述中
参见:https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html