使用准引号将参数列表传递给函数

Passing a list of arguments to a function with quasiquotation

我正在尝试在 R 中编写一个函数,根据分组变量汇总数据框。分组变量以列表形式给出并传递给 group_by_at,我想对它们进行参数化。

我现在做的是这样的:

library(tidyverse)

d = tribble(
  ~foo, ~bar, ~baz,
  1, 2, 3,
  1, 3, 5
  4, 5, 6,
  4, 5, 1
)

sum_fun <- function(df, group_vars, sum_var) {
  sum_var = enquo(sum_var)
  return(
    df %>% 
      group_by_at(.vars = group_vars) %>% 
      summarize(sum(!! sum_var))
  )
}

d %>% sum_fun(group_vars = c("foo", "bar"), baz)

不过,我想这样调用函数:

d %>% sum_fun(group_vars = c(foo, bar), baz)

这意味着不应在调用中评估分组变量,而应在函数中评估。我将如何重写函数以启用它?

我试过像摘要变量一样使用 enquo,然后将 group_vars 替换为 !! group_vars,但它会导致此错误:

Error in !group_vars : invalid argument type

使用 group_by(!!!group_vars) 产生:

Column `c(foo, bar)` must be length 2 (the number of rows) or one, not 4 

重写函数的正确方法是什么?

你可以利用椭圆...。举个例子:

sum_fun <- function(df, sum_var, ...) {
  sum_var <- substitute(sum_var)
  grps    <- substitute(list(...))[-1L]
  return(
    df %>% 
      group_by_at(.vars = as.character(grps)) %>% 
      summarize(sum(!! sum_var))
  )
}

d %>% sum_fun(baz, foo, bar)

我们采用附加参数并从中创建一个列表。之后我们使用非标准评估 (substitute) 来获取变量名并阻止 R 评估它们。由于 group_by_at 需要一个字符或数字类型的对象,我们只需将名称向量转换为字符向量,函数就会按照我们的预期进行计算。

> d %>% sum_fun(baz, foo, bar)
# A tibble: 3 x 3
# Groups:   foo [?]
    foo   bar `sum(baz)`
  <dbl> <dbl>      <dbl>
1     1     2          3
2     1     3          5
3     4     5          7

如果您不想将分组变量作为任意数量的附加参数提供,那么您当然可以使用命名参数:

sum_fun <- function(df, sum_var, grps) {
  sum_var <- enquo(sum_var)
  grps    <- as.list(substitute(grps))[-1L]
  return(
    df %>% 
      group_by_at(.vars = as.character(grps)) %>% 
      summarize(sum(!! sum_var))
  )
}

sum_fun(mtcars, sum_var = hp, grps = c(cyl, gear))

我使用替代的原因是它可以很容易地在其组件中拆分表达式 list(cyl, gear)。可能有一种方法可以使用 rlang,但到目前为止我还没有深入研究那个包。

我只使用 vars 来引用。这是一个使用 mtcars 数据集

的示例
library(tidyverse)

sum_fun <- function(.data, .summary_var, .group_vars) {
  summary_var <- enquo(.summary_var)

  .data %>%
    group_by_at(.group_vars) %>%
    summarise(mean = mean(!!summary_var))
}

sum_fun(mtcars, disp, .group_vars = vars(cyl, am))
#> # A tibble: 6 x 3
#> # Groups:   cyl [?]
#>     cyl    am  mean
#>   <dbl> <dbl> <dbl>
#> 1     4     0 136. 
#> 2     4     1  93.6
#> 3     6     0 205. 
#> 4     6     1 155  
#> 5     8     0 358. 
#> 6     8     1 326

您也可以将 .group_vars 替换为 ...(点-点-点)

sum_fun2 <- function(.data, .summary_var, ...) {
  summary_var <- enquo(.summary_var)

  .data %>%
    group_by_at(...) %>%  # Forward `...`
    summarise(mean = mean(!!summary_var))
}

sum_fun2(mtcars, disp, vars(cyl, am))
#> # A tibble: 6 x 3
#> # Groups:   cyl [?]
#>     cyl    am  mean
#>   <dbl> <dbl> <dbl>
#> 1     4     0 136. 
#> 2     4     1  93.6
#> 3     6     0 205. 
#> 4     6     1 155  
#> 5     8     0 358. 
#> 6     8     1 326

如果您更喜欢以列列表的形式提供输入,则需要对 ...

使用 enquos
sum_fun3 <- function(.data, .summary_var, ...) {
  summary_var <- enquo(.summary_var)

  group_var <- enquos(...)
  print(group_var)

  .data %>%
      group_by_at(group_var) %>% 
      summarise(mean = mean(!!summary_var))
}

sum_fun3(mtcars, disp, c(cyl, am))
#> [[1]]
#> <quosure>
#>   expr: ^c(cyl, am)
#>   env:  global
#> 
#> # A tibble: 6 x 3
#> # Groups:   cyl [?]
#>     cyl    am  mean
#>   <dbl> <dbl> <dbl>
#> 1     4     0 136. 
#> 2     4     1  93.6
#> 3     6     0 205. 
#> 4     6     1 155  
#> 5     8     0 358. 
#> 6     8     1 326

编辑:将 .addi_var 附加到 .../.group_var

sum_fun4 <- function(.data, .summary_var, .addi_var, .group_vars) {
  summary_var <- enquo(.summary_var)

  .data %>%
    group_by_at(c(.group_vars, .addi_var)) %>%
    summarise(mean = mean(!!summary_var))
}

sum_fun4(mtcars, disp, .addi_var = vars(gear), .group_vars = vars(cyl, am))
#> # A tibble: 10 x 4
#> # Groups:   cyl, am [?]
#>      cyl    am  gear  mean
#>    <dbl> <dbl> <dbl> <dbl>
#>  1     4     0     3 120. 
#>  2     4     0     4 144. 
#>  3     4     1     4  88.9
#>  4     4     1     5 108. 
#>  5     6     0     3 242. 
#>  6     6     0     4 168. 
#>  7     6     1     4 160  
#>  8     6     1     5 145  
#>  9     8     0     3 358. 
#> 10     8     1     5 326

group_by_at()也可以将输入作为列名的字符向量

sum_fun5 <- function(.data, .summary_var, .addi_var, ...) {

  summary_var <- enquo(.summary_var)
  addi_var    <- enquo(.addi_var)
  group_var   <- enquos(...)

  ### convert quosures to strings for `group_by_at`
  all_group <- purrr::map_chr(c(addi_var, group_var), quo_name)

  .data %>%
    group_by_at(all_group) %>% 
    summarise(mean = mean(!!summary_var))
}

sum_fun5(mtcars, disp, gear, cyl, am)
#> # A tibble: 10 x 4
#> # Groups:   gear, cyl [?]
#>     gear   cyl    am  mean
#>    <dbl> <dbl> <dbl> <dbl>
#>  1     3     4     0 120. 
#>  2     3     6     0 242. 
#>  3     3     8     0 358. 
#>  4     4     4     0 144. 
#>  5     4     4     1  88.9
#>  6     4     6     0 168. 
#>  7     4     6     1 160  
#>  8     5     4     1 108. 
#>  9     5     6     1 145  
#> 10     5     8     1 326

reprex package (v0.2.1.9000)

创建于 2018-10-09

您可以使用 dplyr::group_by()dplyr::across()curly curly embracing {{ 的组合重写函数。这适用于 dplyr 1.0.0 及更高版本。

为了清楚起见,我已经编辑了原始示例和代码。

library(tidyverse)

my_data <- tribble(
  ~foo, ~bar, ~baz,
   "A",  "B",    3,
   "A",  "C",    5,
   "D",  "E",    6,
   "D",  "E",    1
)

sum_fun <- function(.data, group, sum_var) {
    .data %>% 
      group_by(across({{ group }})) %>% 
      summarize("sum_{{sum_var}}" := sum({{ sum_var }}))
}

sum_fun(my_data, group = c(foo, bar), sum_var = baz)
#> `summarise()` has grouped output by 'foo'. You can override using the `.groups` argument.
#> # A tibble: 3 x 3
#> # Groups:   foo [2]
#>   foo   bar   sum_baz
#>   <chr> <chr>   <dbl>
#> 1 A     B           3
#> 2 A     C           5
#> 3 D     E           7

reprex package (v2.0.0)

于 2021-09-06 创建