MatplotlibのSubplotをより簡単に

# MatplotlibのSubplotをより簡単に。
>度々投稿してきた自作ライブラリ[patchworklib](https://github.com/ponnhide/patchworklib)の紹介記事最終版。自分が欲しい機能はほぼ実装できたので、あとは整ったドキュメントつくれば終わりだろうか。ノリで開発するもんじゃなかったなと反省。以下紹介記事。

[Matplotlib](https://matplotlib.org/) は Pythonで最も利用されている可視化パッケージですが、論文やプレゼンにつかえるような綺麗なプロットを作成するためには複雑な構文をマスターする必要があります。特に、サブプロットの機能は十分に洗練されているとは言い難く、プロットが互いに重ならないように配置したり、プロットの枠を揃える、テキストの位置を揃える、いくつかのサブプロットに対して共通のタイトルを設定する、といった自身の理想とするレイアウトを達成するためには、時に何百行ものコードを書く必要が出てきます。

さらに、matplotlibに実装されているサブプロットの関数は、事前にFigure全体のレイアウト決定することを強制するため、Jupyter-lab のような対話型プログラミング環境でもサブプロットのレイアウトを逐次、確認、修正したりするようなことはできません（matplotlib v3.4から実装されているsubplot_mosiac関数を使えばsubplotのレイアウトを簡単に定義できますが、それでも一度決めたレイアウトを変更することは容易ではありません。）。

また、[Seaborn](https://seaborn.pydata.org/index.html)や[plotnine](https://plotnine.readthedocs.io/en/stable/)のように、数行のPythonコードで美しいプロットを作成してくれる素晴らしいデータ可視化パッケージが存在しますが、両パッケージが生成するプロットの中には、matplotlib のサブプロットとして扱えないものがあります（両パッケージは matplotlib をベースに実装されいるにも関わらずです）。

そのため、複数のプロットの配置する場合、結局subplotの機能は使わずに、keynote や Powerpoint、イラストレータなどの別のGUI ソフトを使用して手動で配置しているの方も多いのではないでしょうか？しかし、このような作業は非常に骨がおれる作業です。また、手動で編集する部分が多くなるほど、visualizaitonの再現性は低下していきますし、レイアウトを修正するのも大変になります。

こうした問題を解決するために、私は最近、複数の matplotlib プロットを`|`と`/`演算子だけを使って素早く配置できる新しいサブプロットマネージャ、[patchworklib](https://github.com/ponnhide/patchworklib) の開発に取り組んできました。

## Patchworklibの使い方
patchworklib モジュールは matplotlib.axes.Axes クラスのサブクラスとして実装されたBrick クラスを提供します。各Brickクラスオブジェクトは、他のBrickクラスオブジェクトと｜や｜演算子で結合することができます。従って、patchworklib を使用すると、次のように簡単な Python コードで 2 つのサブプロットをすばやく配置することができます。

```python
import patchworklib as pw
ax1 = pw.Brick("ax1", figsize=(3,3))
ax2 = pw.Brick("ax2", figsize=(1,3)) 
ax1.set_title("ax1")
ax2.set_title("ax2") 
ax12 = ax1|ax2
ax12.savefig()
```

![download.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/167957/26380ce1-a564-61f7-f9fe-33fe6fe8dd1c.png)

めちゃくちゃ簡単です。ax1とax2の位置を入れ替えたレイアウトもすぐに試すことができます。

```python
ax21 = ax2|ax1
ax21.savefig()
```
![download.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/167957/1502a5f2-cddf-c581-ee7d-9638c2851c7a.png)


そして、matplotlibでやろうとすると地味に難しい「subplotに共通xlabel, ylabelをつける」といったことも簡単に実現できます。

```python
ax21.set_supspine("bottom")
ax21.set_supxlabel("hoge")
ax21.savefig()
```

![download.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/167957/3a466c4e-79bc-cbc5-891e-4109010e01ea.png)



もちろん、こうして作ったFigureは別のFigureと簡単に結合することも可能です。

```python
ax3 = pw.Brick("ax3", figsize=(2,1))
ax4 = pw.Brick("ax4", figsize=(2,2))
ax3.set_title("ax3")
ax4.set_title("ax4") 
ax34 = ax3/ax4
(ax21|ax34).savefig()
```

![download.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/167957/043c5f01-6b8e-ab15-be84-20ad02e79f28.png)


このとき2つのFigureの大きさは互いの枠線が揃うように自動的に調節されます。ただ人によっては、枠線ではなくて、2つのFigureの文字の端を揃えたいと思う人もいるかもしれません。それも簡単です。

```python
(ax21.outline|ax34.outline).savefig()
```

![download.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/167957/ae5b1151-a602-d173-35c2-7cd17bb3b9e1.png)

図の枠線ではなくて、外側の文字の端が揃うように図の大きさが調節されているのがわかるでしょうか？こんな感じでpatchworklibはとても簡単にsubplotのレイアウトを調整することを可能にします。

ついでに、Figure中の特定のsubplotを指定して、その隣に別のsubplotを配置することもできます。例えば、ax34の中のax4の右にax21を置くといったレイアウトにする場合は以下のようになります。

```python
(ax34["ax4"]|ax21).savefig()
```

![download.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/167957/b8964d16-d225-00af-45af-2637158f902c.png)

## Seaborn plotを並べる。
もう少し複雑な図にしたら、図が重なったりするのじゃないのかって？そんなことはありません。
では、simpleなseabornのplotを幾つか並べてみましょう。

```python
import seaborn as sns
import patchworklib as pw

#ax1
ax1 = pw.Brick("ax1", figsize=(3,2))
fmri = sns.load_dataset("fmri")
sns.lineplot(x="timepoint", y="signal", hue="region", style="event", data=fmri, ax=ax1)
ax1.move_legend(new_loc='upper left', bbox_to_anchor=(1.05, 1.0))
ax1.set_title("ax1")

#ax2
ax2 = pw.Brick("ax2", figsize=(1,2))
titanic = sns.load_dataset("titanic")
sns.barplot(x="sex", y="survived", hue="class", data=titanic, ax=ax2)
ax2.move_legend(new_loc='upper left', bbox_to_anchor=(1.05, 1.0))
ax2.set_title("ax2")

#ax3
ax3 = pw.Brick("ax3", (5,2))
diamonds = sns.load_dataset("diamonds")
sns.histplot(diamonds, x="price", hue="cut", multiple="stack", palette="light:m_r", edgecolor=".3", linewidth=.5, log_scale=True, ax = ax3)
ax3.move_legend(new_loc='upper left', bbox_to_anchor=(1.0, 1.0))
ax3.set_title("ax3")

#ax4
ax4 = pw.Brick("ax4", (6,2))
tips = sns.load_dataset("tips")
sns.violinplot(data=tips, x="day", y="total_bill", hue="smoker",split=True, inner="quart", linewidth=1, palette={"Yes": "b", "No": ".85"}, ax=ax4)
ax4.move_legend("upper left", bbox_to_anchor=(1.02, 1.0))
ax4.set_title("ax4")

#ax5
ax5    = pw.Brick("ax5", (5,2))
rs     = np.random.RandomState(365)
values = rs.randn(365, 4).cumsum(axis=0)
dates  = pd.date_range("1 1 2016", periods=365, freq="D")
data   = pd.DataFrame(values, dates, columns=["A", "B", "C", "D"])
data = data.rolling(7).mean()
sns.lineplot(data=data, palette="tab10", linewidth=2.5, ax=ax5)
ax5.set_xlabel("date")
ax5.set_ylabel("value")
ax5.move_legend("upper left", bbox_to_anchor=(1.02, 1.0))
ax5.set_title("ax5")

#patchwork
ax35421 = (ax3/ax4)|(ax5/(ax2|ax1))
ax35421.savefig()
```

![](https://storage.googleapis.com/zenn-user-upload/fe89439cc974-20220423.png)

結果はご覧の通り。ちゃんとlegendの位置も検知して、図が重ならないように、そして枠線は揃うように自動的に配置してくれます。ついでに、subplot同士のmarginの大きさを変えたければ、`pw.param["margin"]`の値をお好みの値（デフォルトは`0.5 inch`）に変えてから、プロットし直してください。

## Figure-levelのSeaborn plotを並べる。
ぶっちゃけた話、上記のようなレイアウトのFigureはpathckworlibを使わなくてもmatplotlibとseabornを駆使すれば作れないことはありません。なぜなら、上記のseaborn plotは全てAxes-levelのplotというものでmatplotlibのsubplotとして扱えるように実装されていれるからです。しかし、SeabornのplotにはFigure全体を利用することが前提でつくられたFigure-levelのplotというものが存在します。seabornにおけるFigure-level、Axes-levelの違いを知りたい人は、英語になりますが、以下のページを参考にしてください。
https://seaborn.pydata.org/tutorial/function_overview.html

これまで基本的に、Figure-levelのplotを複数並べる方法は、それぞれのFigureを別々に出力したのち手動で並べる以外にはありませんでした。しかし、patchworklibはFigure-levelのplotをAxes-levelのplotへと変換する機能を有しているので、Figure-levelのplotを綺麗に配置することもお茶の子さいさいです。

```python
import seaborn as sns
import patchworklib as pw
pw.overwrite_axisgrid() #When you use pw.load_seagorngrid, the 'overwrite_axisgrid' method should be executed.
#g1
df = sns.load_dataset("penguins")
g1 = sns.pairplot(df, hue="species")
g1 = pw.load_seaborngrid(g1)
g1.move_legend("upper left", bbox_to_anchor=(0.17,1.01))
#g2
planets = sns.load_dataset("planets")
cmap    = sns.cubehelix_palette(rot=-.2, as_cmap=True)
g2      = sns.relplot(data=planets, x="distance", y="orbital_period", hue="year", size="mass", palette=cmap, sizes=(10, 200))
g2.set(xscale="log", yscale="log")
g2.ax.xaxis.grid(True, "minor", linewidth=.25)
g2.ax.yaxis.grid(True, "minor", linewidth=.25)
g2.despine(left=True, bottom=True)
g2 = pw.load_seaborngrid(g2)
#g3
penguins = sns.load_dataset("penguins")
g3 = sns.jointplot(data=penguins,x="bill_length_mm", y="bill_depth_mm", hue="species", kind="kde")
g3 = pw.load_seaborngrid(g3, labels=["joint","marg_x","marg_y"])
#patchwork
((g2.outline/g3.outline)|g1).savefig()
```
![](https://storage.googleapis.com/zenn-user-upload/cfc4aa87e6f8-20220423.png)

便利な機能ではありますが、patchworlibの作成者（筆者）はちょっとヤリすぎな感じがしますね。。。
最近、clustermapのplotも扱えるようにしたため、あらゆるseabornのFigure-level plotをsubplot（もしくはsubplotの集合）として扱うことが可能です。

## plotnine plotを並べる
ここまで読んでくれた方は気づいているかもしれませんが、そうです。patchworklibはggplotのsubplotライブラリ[patchwork](https://patchwork.data-imaginist.com/)のパクリです。ぶっちゃけた話、python,matplotlibでなくてR,ggplotを使って解析してるひとは本家patchworkを使った方が10倍幸せになれます。
しかし、Jupyterlabやら、Google colabやら世の中はpython以外をあまり受け入れてくれない（Rも一応使えるけどね）環境がたくさんあります。ggplotが大好きな皆さんもmatplotlibを使わざる得なかったことがあるのではないのでしょうか。そんなあなたの救世主。それが[plotnine](https://plotnine.readthedocs.io/en/stable/)。matplotlibをベースにggplotのsyntaxを完全実装してしまった恐ろしいライブラリです。しかし、一つ大きな欠点がありました。それが、本家のpatchworkにあたるようなライブラリがなく、subplotの機能が全く実装されていないこと、でした。
でも、もう問題ありません。patchworkのパクリpatchworklibを使えば、plotnineのplotも以下のように簡単に並べられます。なんなら、matplotlibやseabornのplotとだって並べられます。

```python
import patchworklib as pw 
from plotnine import * 
from plotnine.data import *  
g1 = (ggplot(mtcars) + geom_point(aes("mpg", "disp"))) 
g1 = pw.load_ggplot(g1, figsize=(2,3))
g2 = (ggplot(mtcars) + geom_boxplot(aes("gear", "disp", group="gear"))) 
g2 = pw.load_ggplot(g2, figsize=(2,3))
g3 = (ggplot(mtcars, aes('wt', 'mpg', color='factor(gear)')) + geom_point() + stat_smooth(method='lm') + facet_wrap('~gear')) 
g3 = pw.load_ggplot(g3, figsize=(3,3))
g4 = (ggplot(data=diamonds) + geom_bar(mapping=aes(x="cut", fill="clarity"), position="dodge"))  
g4 = pw.load_ggplot(g4, figsize=(5,2))
#patchwork
g1234 = (g1|g2|g3)/g4 
g1234.savefig()
```
![](https://storage.googleapis.com/zenn-user-upload/8048789ad3cb-20220423.png)

ここまで、読んでくれた方ありがとうごいます。[Githubのレポジトリ](https://github.com/ponnhide/patchworklib)にstarをくれると喜びます。
そして、誰かドキュメントの作成手伝ってくれたりする方がいたら喜びます。
~~正直、実装だけしてあきた~~

ここで紹介しているコードは、以下のGooglecolab上で実際に動かすことが可能です。気になった人は触ってみてください。

- [tutorial](https://colab.research.google.com/drive/1TVcH3IJy6geDXVJDfOKCPFPsP2GzjxHu?usp=sharing): Basic example codes of patchworklib 
- [subplot4plotnine](https://colab.research.google.com/drive/17otXpvh-jLn0joI2MwdyT6RKJzx6Anwp?usp=sharing): Arranging plotnine plots using patchworklib
- [subplot4seaborngrid](https://colab.research.google.com/drive/1C1EN1-5L2QjnAAVo4vpx_i9knDRzX4jy?usp=sharing): Arranging figure level seaborn plots using patchworklib