在 R 函数中指定可选参数的“正确”方式

Question

我对在 R 中编写带有可选参数的函数的“正确”方式很感兴趣。 随着时间的推移，我偶然发现了几段在这里采用不同路线的代码，我在这个主题上找不到合适的（官方）立场。

到目前为止，我已经编写了这样的可选参数：

fooBar <- function(x,y=NULL){
  if(!is.null(y)) x <- x+y
  return(x)
}
fooBar(3) # 3
fooBar(3,1.5) # 4.5

如果只提供了x，函数只会返回它的参数。它对第二个参数使用默认的 NULL 值，如果该参数恰好不是 NULL，则该函数将这两个数字相加。

或者，可以这样编写函数（其中第二个参数需要按名称指定，但也可以unlist(z) 或定义z <- sum(...) 代替）：

fooBar <- function(x,...){
  z <- list(...)
  if(!is.null(z$y)) x <- x+z$y
  return(x)
}
fooBar(3) # 3
fooBar(3,y=1.5) # 4.5

我个人更喜欢第一个版本。但是，我可以看到两者的好坏。第一个版本不太容易出错，但第二个版本可用于合并任意数量的选项。

在 R 中是否有一种“正确”的方式来指定可选参数？到目前为止，我已经确定了第一种方法，但两者有时都会觉得有点“hacky”。​​

Answer 1

这个怎么样？

fun <- function(x, ...){
  y=NULL
  parms=list(...)
  for (name in names(parms) ) {
    assign(name, parms[[name]])
  }
  print(is.null(y))
}

那就试试吧：

> fun(1,y=4)
[1] FALSE
> fun(1)
[1] TRUE

Answer 2

只是想指出，内置的sink 函数有很好的例子来说明在函数中设置参数的不同方法：

> sink
function (file = NULL, append = FALSE, type = c("output", "message"),
    split = FALSE)
{
    type <- match.arg(type)
    if (type == "message") {
        if (is.null(file))
            file <- stderr()
        else if (!inherits(file, "connection") || !isOpen(file))
            stop("'file' must be NULL or an already open connection")
        if (split)
            stop("cannot split the message connection")
        .Internal(sink(file, FALSE, TRUE, FALSE))
    }
    else {
        closeOnExit <- FALSE
        if (is.null(file))
            file <- -1L
        else if (is.character(file)) {
            file <- file(file, ifelse(append, "a", "w"))
            closeOnExit <- TRUE
        }
        else if (!inherits(file, "connection"))
            stop("'file' must be NULL, a connection or a character string")
        .Internal(sink(file, closeOnExit, FALSE, split))
    }
}

Answer 3

我倾向于使用 NULL 来明确什么是必需的，什么是可选的。正如 Jthorpe 所建议的，关于使用依赖于其他参数的默认值的警告。该值不是在调用函数时设置的，而是在第一次引用参数时设置的！例如：

foo <- function(x,y=length(x)){
    x <- x[1:10]
    print(y)
}
foo(1:20) 
#[1] 10

另一方面，如果您在更改 x 之前引用 y：

foo <- function(x,y=length(x)){
    print(y)
    x <- x[1:10]
}
foo(1:20) 
#[1] 20

这有点危险，因为它很难跟踪正在初始化的“y”，就好像它没有在函数的早期调用一样。

Answer 4

老实说，我喜欢 OP 的第一种方式，它以 NULL 值实际启动它，然后用 is.null 进行检查（主要是因为它非常简单易懂）。这可能取决于人们习惯于编码的方式，但 Hadley 似乎也支持 is.null 方式：

来自 Hadley 的书“Advanced-R”第 6 章，函数，第 84 页（在线版本检查here）：

您可以使用 missing() 函数确定是否提供了参数。

i <- function(a, b) {
  c(missing(a), missing(b))
}
i()
#> [1] TRUE TRUE
i(a = 1)
#> [1] FALSE  TRUE
i(b = 2)
#> [1]  TRUE FALSE
i(1, 2)
#> [1] FALSE FALSE

有时您想要添加一个重要的默认值，这可能需要几行代码来计算。如果需要，您可以使用 missing() 有条件地计算它，而不是在函数定义中插入该代码。 但是，如果不仔细阅读文档，就很难知道哪些参数是必需的，哪些是可选的。相反，我通常将默认值设置为 NULL 并使用 is.null() 检查是否提供了参数。

Answer 5

这些是我的经验法则：

如果可以从其他参数计算出默认值，则使用默认值 表达式如下：

fun <- function(x,levels=levels(x)){
    blah blah blah
}

如果否则使用missing

fun <- function(x,levels){
    if(missing(levels)){
        [calculate levels here]
    }
    blah blah blah
}

在罕见的情况下，用户可能希望指定默认值 持续整个 R 会话，请使用 getOption

fun <- function(x,y=getOption('fun.y','initialDefault')){# or getOption('pkg.fun.y',defaultValue)
    blah blah blah
}

如果根据第一个参数的类应用某些参数， 使用 S3 泛型：

fun <- function(...)
    UseMethod(...)


fun.character <- function(x,y,z){# y and z only apply when x is character
   blah blah blah 
}

fun.numeric <- function(x,a,b){# a and b only apply when x is numeric
   blah blah blah 
}

fun.default <- function(x,m,n){# otherwise arguments m and n apply
   blah blah blah 
}

仅当您将其他参数传递给 另一个函数

cat0 <- function(...)
    cat(...,sep = '')

最后，如果您选择使用 ... 而不将点传递给另一个函数，警告用户您的函数忽略了任何未使用的参数，因为它可能非常 em> 否则会令人困惑：

fun <- (x,...){
    params <- list(...)
    optionalParamNames <- letters
    unusedParams <- setdiff(names(params),optionalParamNames)
    if(length(unusedParams))
        stop('unused parameters',paste(unusedParams,collapse = ', '))
   blah blah blah 
}

Answer 6

有几个选项，它们都不是官方正确的方法，也没有一个是真正不正确的，尽管它们可以向计算机和其他阅读您的代码的人传达不同的信息。

对于给定的示例，我认为最明确的选择是提供标识默认值，在这种情况下，请执行以下操作：

fooBar <- function(x, y=0) {
  x + y
}

这是迄今为止显示的选项中最短的一个，简短有助于提高可读性（有时甚至提高执行速度）。很明显，返回的是 x 和 y 的总和，您可以看到 y 没有被赋予一个值为 0 的值，当添加到 x 时只会产生 x。显然，如果使用比加法更复杂的东西，则需要不同的标识值（如果存在的话）。

我真正喜欢这种方法的一点是，在使用args 函数时，甚至查看帮助文件（您无需向下滚动到详细信息，它就在用法中）。

这种方法的缺点是当默认值很复杂（需要多行代码）时，尝试将所有这些都放入默认值可能会降低可读性，missing 或 NULL 方法会变成更合理。

当参数被传递给另一个函数时，或者使用match.call 或sys.call 函数时，方法之间的一些其他差异会出现。

所以我猜“正确”的方法取决于您打算如何处理该特定参数以及您想向代码读者传达什么信息。

Answer 7

您还可以使用missing() 来测试是否提供了参数y：

fooBar <- function(x,y){
    if(missing(y)) {
        x
    } else {
        x + y
    }
}

fooBar(3,1.5)
# [1] 4.5
fooBar(3)
# [1] 3