def-magical.qmd

# Avoid magical defaults {#sec-def-magical}

```{r}
#| include = FALSE,
#| cache = FALSE
source("common.R")
```

```{r}
#| eval = FALSE,
#| include = FALSE
source("fun_def.R")
funs <- c(pkg_funs("base"), pkg_funs("stats"), pkg_funs("utils"))
funs %>% funs_formals_keep(~ is_symbol(.x) && !is_missing(.x))
pkg_funs("base") %>% funs_body_keep(has_call, "missing")
```

## What's the problem?

If a function behaves differently when the default value is supplied explicitly, we say it has a **magical default**.
Magical defaults are best avoided because they make it harder to interpret the function specification.

## What are some examples?

-   In `data.frame()`, the default argument for `row.names` is `NULL`, but if you supply it directly you get a different result:

    ```{r}
    args(data.frame)

    x <- setNames(nm = letters[1:2])
    x

    data.frame(x)

    data.frame(x, row.names = NULL)
    ```

-   In `hist()`, the default value of `xlim` is `range(breaks)`, and the default value for `breaks` is `"Sturges"`.
    `range("Sturges")` returns `c("Sturges", "Sturges")` which doesn't work when supplied explicitly:

    ```{r}
    #| error = TRUE,
    #| fig.show = "hide"
    args(hist.default)

    hist(1:10, xlim = c("Sturges", "Sturges"))
    ```

-   `readr::read_csv()` has `progress = show_progress()`, but until version 1.3.1, `show_progress()` was not exported from the package.
    That means if you attempted to run it yourself, you'd see an error message:

    ```{r}
    #| error = TRUE
    show_progress()
    ```

## What are the exceptions?

It's ok to use this behaviour when you want the default value of one argument to be the same as another.
For example, take `rlang::set_names()`, which allows you to create a named vector from two inputs:

```{r}
library(rlang)
args(set_names)

set_names(1:3, letters[1:3])
```

The default value for the names is the vector itself.
This provides a convenient shortcut for naming a vector with itself:

```{r}
set_names(letters[1:3])
```

You can see this same technique in `merge()`, where `all.x` and `all.y` default to the same value as `all`, and in `factor()` where `labels` defaults to the same value as `levels`.

If you use this technique, make sure that you never use the value of an argument that comes later in the argument list.
For example, in `file.copy()` `overwrite` defaults to the same value as `recursive`, but the `recursive` argument is defined after `overwrite`:

```{r}
args(file.copy)
```

This makes the defaults arguments harder to understand because you can't just read from left-to-right.

## What causes the problem?

This problem is generally easy to avoid for new functions:

-   Don't use default values that depend on variables defined inside the function.
    The default values of function arguments are lazily evaluated in the environment of the function when they are first used, as described in [Advanced R](https://adv-r.hadley.nz/functions.html#default-arguments). Here's a simple example:

    ```{r}
    f1 <- function(x = y) {
      y <- 2
      x
    }

    y <- 1
    f1()
    f1(y)
    ```

    When `x` takes the value `y` from its default, it's evaluated inside the function, yielding `1`.
    When `y` is supplied explicitly, it is evaluated in the caller environment, yielding `2`.

-   Don't use `missing()`\[\^def-magical-1\].

    ```{r}
    f2 <- function(x = 1) {
      if (missing(x)) {
        2
      } else {
        x
      }
    }

    f2()
    f2(1)
    ```

-   Don't use unexported functions.
    In packages, it's easy to use a non-exported function without thinking about it.
    This function is available to you, the package author, but not the user of the package, which makes it harder for them to understand how a package works.

## How do I remediate the problem?

If you have a made a mistake in an older function you can remediate it by using a `NULL` default, as described in @sec-defaults-short-and-sweet).
If the problem is caused by an unexported function, you can also choose to document and export it.
Remediating this problem shouldn't break existing code, because it expands the function interface: all previous code will continue to work, and the function will also work if the argument is passed `NULL` input (which probably didn't previously).