RのTidy evaluation

はじめに

この記事はTidy evaluationをもとにTidy evaluationについて学習した内容を自分の備忘録としてまとめたものです。

おさらい

Tidy Evaluationで重要だと思っているQuosure。これは「表現式を評価せずに、評価させるべき環境を記憶する」という考え方。exprが未評価の表現式で、envが表現が評価される環境を表す。

library(rlang)

quo(x + y)
<quosure>
expr: ^x + y
env:  global

quo(z)
<quosure>
expr: ^z
env:  global

足し算関数を定義して、Quosureの挙動をもう少し理解してみる。expr: ^x + yが表現式、env:0x113292a00が環境となってる。つまり、0x113292a00の環境でx + yが評価されるようになっている。

add <- function(x, y){
  quo(x + y)
}

add(100, 1)
<quosure>
expr: ^x + y
env:  0x113292a00

eval_tidy()で表現式を評価してみると、期待通りに動いてくれる。つまりx=100、y=1は0x113292a00という環境に情報が残される。

eval_tidy(add(100, 1))
[1] 101

Tidy Evaluationでもう1つ重要だと思われるUnquoteという考え方。これは、表現式をクオートしたものを一時的にクオート外すことができる機能。!!(bang-bang)演算子でアンクオートできる。

x <- 1
y <- 101

quo(add(x, y))
<quosure>
expr: ^add(x, y)
env:  global

quo(add(!!x, !!y))
<quosure>
expr: ^add(1, 101)
env:  global

関数化する

関数を定義するときに、これらの考え方を利用する。mpgというデータには、yearというカラムが存在する。

mpg %>% head(3)
# A tibble: 3 x 11
  manufacturer model displ  year   cyl trans      drv     cty   hwy fl    class  
  <chr>        <chr> <dbl> <int> <int> <chr>      <chr> <int> <int> <chr> <chr>  
1 audi         a4      1.8  1999     4 auto(l5)   f        18    29 p     compact
2 audi         a4      1.8  1999     4 manual(m5) f        21    29 p     compact
3 audi         a4      2    2008     4 manual(m6) f        20    31 p     compact

これを、そのまま実行してみると、エラーが返されが、クオートしておけば、評価は実行されないので、エラーは返されない。

year
 エラー:  オブジェクト 'year' がありません 

quo(year)
<quosure>
expr: ^year
env:  global

dplyrのfilter()でyearを使っても、エラーが返されない。これは、mpgというデータセットの環境内で、yearが評価されているから。

mpg %>% 
  filter(year > 2007) %>% 
  head(3)

# A tibble: 3 x 11
  manufacturer model displ  year   cyl trans drv     cty   hwy fl   
  <chr>        <chr> <dbl> <int> <int> <chr> <chr> <int> <int> <chr>
1 audi         a4      2    2008     4 manu… f        20    31 p    
2 audi         a4      2    2008     4 auto… f        21    30 p    
3 audi         a4      3.1  2008     6 auto… f        18    27 p

フィルターを関数化してみるとエラーが返される。

quo_filter <- function(df, expr){
  quo_expr <- quo(expr)
  list(df %>% filter(quo_expr) %>% head(3),
       quo_expr)
}
エラー: Argument 2 filter condition does not evaluate to a logical vector

quo()は関数内の入力をそのまま評価するため、enquo()が必要。base::substitute()みたいな感じ。

quo_env <- function(col) {
  print(quo(col))
  print(enquo(col))
  environment()
}

quo_env(x + y)
<quosure>
expr: ^col
env:  0x11f883b60

<quosure>
expr: ^x + y
env:  global

<environment: 0x11f883b60>

quo_filter()を修正します。なので、yearというのはグローバル環境では知られていません・・・なので、enquo()で評価を遅らせて、評価すべき環境とタイミングで!!でクオートを外すことで、評価させる、みたいなイメージ。あってるかな…。

quo_filter <- function(df, expr){
  quo_expr <- enquo(expr)
  list(df %>% filter(!!quo_expr) %>% head(3),
       quo_expr)
}

quo_filter(mpg, year > 2007)
[[1]]
# A tibble: 3 x 11
  manufacturer model displ  year   cyl trans drv     cty   hwy
  <chr>        <chr> <dbl> <int> <int> <chr> <chr> <int> <int>
1 audi         a4      2    2008     4 manu… f        20    31
2 audi         a4      2    2008     4 auto… f        21    30
3 audi         a4      3.1  2008     6 auto… f        18    27
# … with 2 more variables: fl <chr>, class <chr>

[[2]]
<quosure>
expr: ^year > 2007
env:  global

同時にquosureも出力してみたが、このときにenv:globalなのが気になる。下記のようにmpgの環境env: 0x11dcbf770で評価するよ、見たく表示されないのかな…ここらへんの知識がまだ私には足りていない。おそらく、df %>%が前にくることで、環境をセットしているのだろう…けど、うまい方法がわからない。

mpg %>% vars(., year > 2007)
<list_of<quosure>>

[[1]]
<quosure>
expr: ^.
env:  0x11dcbf770

[[2]]
<quosure>
expr: ^year > 2007
env:  0x11dcbf770

って直しても、１つ目はenv: 0x11dd67dc8なんだけど、２つ目はenv: globalになるのよな…。

quo_filter <- function(df, expr){
  quo_expr <- enquo(expr)
  list(df %>% filter(!!quo_expr) %>% head(3),
       df %>% vars(!!quo_expr))
}

quo_filter(mpg, year > 2007)
[[1]]
# A tibble: 3 x 11
  manufacturer model displ  year   cyl trans drv     cty   hwy
  <chr>        <chr> <dbl> <int> <int> <chr> <chr> <int> <int>
1 audi         a4      2    2008     4 manu… f        20    31
2 audi         a4      2    2008     4 auto… f        21    30
3 audi         a4      3.1  2008     6 auto… f        18    27
# … with 2 more variables: fl <chr>, class <chr>

[[2]]
<list_of<quosure>>

[[1]]
<quosure>
expr: ^.
env:  0x11dd67dc8

[[2]]
<quosure>
expr: ^year > 2007
env:  global

わからないことがどんどん増える〜。

下記のサイトでは、nグラムを簡単に作成できる関数をtidyevalを使って紹介されています。

[https://www.onceupondata.com/2017/08/12/my-first-steps-into-the-world-of-tidyeval/?utm_content=buffer7e280&utm_medium=social&utm_source=twitter.com&utm_campaign=buffer:embed:cite]

RのTidy evaluation_0

はじめに

おさらい

関数化する