R (tidyverse), inner_join

「計算用の数値を含むデータ」と、「各行を説明する名前 (symbol) や説明の文章などのデータ」という2つのテーブル同士を、それぞれに含まれる共通の列をキーに連結させたいことは、よくある処理だと思います。

このようなとき、R の tidyverse では、 inner_join() 関数を用いて、簡単に結合することができます。

例えば、下記のように2つのテーブルを読み込んだとします。

library(tidyverse)

input_data <- read_tsv("input_data.tsv")
meta_data  <- read_tsv("meta_data.tsv")

テーブルの中身は、下記のようなイメージです。2つのファイルも1列目に id の列を持ちます。

> # 計算用のデータ。
> input_data
# A tibble: 3 x 3
  Id    Sample1 Sample2
  <chr>   <dbl>   <dbl>
1 id1         1       4
2 id2         2       5
3 id3         3       6
>
>
>
> # 各行を説明するデータ。アノテーションの情報など。
> meta_data
# A tibble: 4 x 3
  Id    Symbol Description
  <chr> <chr>  <chr>
1 id1   AAA    lorem ipsum a
2 id2   BBB    lorem ipsum b
3 id3   CCC    lorem ipsum c
4 id4   DDD    lorem ipsum d

2つのテーブルの共通な列である Id をもとに、テーブルを結合するには、下記のように書けます。

result_data <- inner_join(input_data, meta_data)

実行結果は、下記のようになります。

> result_data <- inner_join(input_data, meta_data)
Joining, by = "Id"
> result_data
# A tibble: 3 x 5
  Id    Sample1 Sample2 Symbol Description
  <chr>   <dbl>   <dbl> <chr>  <chr>
1 id1         1       4 AAA    lorem ipsum a
2 id2         2       5 BBB    lorem ipsum b
3 id3         3       6 CCC    lorem ipsum c

Joining, by = “Id” となっていることで、 Id 列をもとに結合されたことが分かります。この場合は、2つのテーブルに同じ名前の列があるので、自動的に認識されています。明示的にキーの列を指定する場合は、inner_join(input_data, meta_data, by = "Id") と書きます。

また、結果のテーブル (result_data) では、元の input_data に含まれない id4 の行がないことが確認できます。

 

R (tidyverse), read_tsv

tidyverse には、タブ区切りテキスト (tsv) を読み込むための関数 read_tsv() が使えます。

library(tidyverse) # パッケージを読み込む。

input_data <- read_tsv("input_data.tsv")

上記の例では、input_data.tsv という名前のファイルを読み込んで、 input_data に格納しています。(csv ファイルであれば、read_csv() 関数で読み込みます。)

> input_data
# A tibble: 3 x 3
  id    sample1 sample2
  <chr>   <dbl>   <dbl>
1 AAA         1       4
2 BBB         2       5
3 CCC         3       6

読み込んだファイルは、従来のデータフレームではなく、 tibble という形式のオブジェクトになります。tibble は下記のような特徴があります。

  • 行名 (rownames) を持たない。(列名は持っている)
  • 列ごとに推論された型を持つ。
  • オブジェクトを表示させると、上から10行が表示される。

サイズの大きいデータの場合、データの先頭だけ表示されるのは便利です。読み込みも早いので、これだけでも tidyverse を使うメリットがあると思います。

よく使うオプションとしては、下記のものがあります。*その他は、help(read_tsv) で確認。

  • skip: ヘッダーが不要だったり、1行目がコメント行だったりするとき。
    • 例:skip = 1
  • col_names: 列名を指定したいとき。
    • 例:col_names = c("id", "sample1", "sample2")
  • col_types: 型推論がうまくいかなかったとき。
    • 例:col_types = cols(id = col_character())
input_data <- read_tsv("input_data.tsv", skip = 1,
                       col_names = c("id", "sample1", "sample2"),
                       col_types = cols(id = col_character(),
                                        sample1 = col_double()))

本家のチートシートが大変参考になります。

Data Import:: CHEAT SHEET

https://github.com/rstudio/cheatsheets/blob/master/data-import.pdf
 

R (tidyverse) の使い方

R のパッケージである tidyverse を使用すると、データの読み込み、変形、出力が簡単になります。特に、これから R を始められる方は、最初から tidyverse を使用した書き方で始める方が分かりやすいと思います。(細かいところは、従来のデータフレームの知識や書式が必要になるかもしれませんが。)

tidyverse を利用したコードのイメージ。

library(tidyverse)

input_data <- read_tsv("input_data.tsv")
meta_data  <- read_tsv("meta_data.tsv")

output_data <- input_data %>% inner_join(meta_data)
write_tsv(output_data, "output_data.tsv")

これだけのコードで、タブ区切りテキスト(TSV)形式のファイルを読み込んで、同じ列名のIDをキーに2つのテーブルを結合して、TSV形式で出力することができます。

短いコードで書くことができ、読みやすい表現が可能なことで、コードのメンテナンス性が良くなります。(多少、冗長な表現であったとしても、わかりやすい方が、後でコードを見返したときに困りません。)

single cell の解析に用いられているパッケージの Seurat など、最近のパッケージは、tidyverse をベースに使用しているため、R の従来の表現から、今後、tidyverse を使った新しい表現に切り替えていくことをお勧めします。