R を使ったサンキーダイアグラムの作り方: NetworkD3 パッケージ

このページの最終更新日: 2025/01/05

概要: サンキーダイアグラムとは
R の sankeyNetwork() 関数
- インプットデータ links
- sankeyNetwork() のオプション
sankeyNetwork() で色をつける
sankeyNetwork() で順番を変える
sankeyNetwork() で html ファイルを出力する

概要: サンキーダイアグラムとは

サンキーダイアグラム Sankey diagram とは、各工程間の流量を示す以下のような図のことである (2)。Sankey にちなんでこのように呼ばれるが、それ以前にも類似の表現方法はあったようである。

1898 年、アイルランドの Sankey が蒸気機関の熱効率を示すのに使ったオリジナルの Sankey diagram (Public domain)。

このページでは、R の networkD3 パッケージに含まれる sanketNetwork 関数でサンキーダイアグラムを作る方法をまとめる。以下のような図ができる (このページの下の方にスクリプトがあります)。サンキーダイアグラムは ggplot でも作ることができ、その方法は ggsankey 関数を使ったサンキーダイアグラム作成のページにまとめた。

R の sankeyNetwork() 関数

R でサンキーダイアグラムの作成に最も使われている関数は、networkD3 というパッケージに含まれる sankeyNetwork だろう。

まずは、このページを参考にシンプルなスクリプトを。

これを実行すると、ページの上の方で示した図が出力される。png と html で出力され、pdf は方法がわからない。

インプットデータ links

上記 script の最後の部分を見るとわかるように、メインとなる input は links という変数である。これは以下のような中身をしている。結構単純に、線の出発点となる source、標的の target および線の太さを指定する value があるだけである。source と target の ID は、# With networkD3, connection must be provided using id, not using real name like in the links の部分で自動で追加される。

なお、この IDsource と IDtarget は numeric であり、文字列になっていると結果が出力されない。str(links) などで確認できる。

上の例では value は整数だが、少数が入っても問題ない。
value = 0 でも線は消えず、非常に細い線が引かれる。
マイナスの値はゼロ扱いになってしまい、細い線になる。

node という変数はさらにシンプルで、node の名前が書いてあるだけである。

sankeyNetwork() のオプション

自分が使ったことのあるもののみ。詳細は R Documentation を参照のこと。

Links	上記のインプットデータの部分で示したような links を指定する。
Nodes	上記のインプットデータの部分で示したような nodes を指定する。
fontSize	fontSize = 10 のようにフォントサイズを指定。
iterations	それぞれの node の y 軸上の位置を計算する回数。ブラウザで計算されるので、高い数を設定しないこと。iterations = 0 を指定すると、nodes autopositioning をオフにでき、入力順に並ぶようになる (参考)。
colourScale	色をつけるときに指定。使い方は、このページの下にある sankeyNetwork() で色をつけるに。
LinkGroup	リンク (線の部分) 色をつけるときに使用。
NodeGroup	ノードに色をつけるときに使用。
nodeWidth	ノードの太さ。nodeWidth = 1 のように数字で指定。0 で node が完全に見えなくなる。
width height	図全体の幅、高さを指定。