Allow FacetGrids use in heatmaps #219

coxipi · 2024-06-10T22:06:37Z

Pull Request Checklist:

This PR addresses an already opened issue (for bug fixes / features)
- This PR fixes #xyz
(If applicable) Documentation has been added / updated (for bug fixes / features).
(If applicable) Tests have been added.
CHANGELOG.rst has been updated (with summary of main changes).
- Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

fg.heatmap can now accept plot_kw = {"row":"dim1", "col":"dim2"} like other functions in Figanos!

Does this PR introduce a breaking change?

No

Other information:

review-notebook-app · 2024-06-10T22:06:42Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

sarahclaude

Looks great, thanks Eric!

Are "row" and "col" the only arguments we can pass to the Seaborn facetgrids in plot_kw?
I tried using height and aspect in plot_kw and it didn't work (https://seaborn.pydata.org/generated/seaborn.FacetGrid.html).

However, it worked great with fig_kw to change the figure size in the docs.

coxipi · 2024-06-11T16:41:52Z

src/figanos/matplotlib/plot.py

+    if ax is None and ("row" not in plot_kw.keys() and "col" not in plot_kw.keys()):
        fig, ax = plt.subplots(**fig_kw)
+    elif ax is not None and ("col" in plot_kw or "row" in plot_kw):
+        raise ValueError("Cannot use 'ax' and 'col'/'row' at the same time.")
+    elif ax is None:
+        if any([k != "figsize" for k in fig_kw.keys()]):
+            warnings.warn(
+                "Only figsize arguments can be passed to fig_kw when using facetgrid."
+            )
+        plot_kw.setdefault("col", None)
+        plot_kw.setdefault("row", None)
+        heatmap_dims = list(
+            set(da.dims)
+            - {d for d in [plot_kw["col"], plot_kw["row"]] if d is not None}
+        )
+        if da.name is None:
+            da = da.to_dataset(name="data").data
+        da_name = da.name


This part is a bit more rudimentary than in gridmap for instance, where figure.add_subplot() is also used in fig_kw

"Only figsize and figure.add_subplot() arguments can be passed to fig_kw when using facetgrid."

I don't think I've seen an example on how to properly use figure.add_subplot() in this context, so I prefer not to advertise any of this. If this is a crucial feature I can try to incorporate it too.

No i don't think it is crucial to have it. I was just wondering how much access we have to seaborn facetgrid options via the function heatmap

coxipi · 2024-06-12T20:02:23Z

Are "row" and "col" the only arguments we can pass to the Seaborn facetgrids in plot_kw?
I tried using height and aspect in plot_kw and it didn't work (https://seaborn.pydata.org/generated/seaborn.FacetGrid.html).

With how I programmed it, yes. I may have misunderstood the general strucutre in Figanos, right now plot_kw is used both in sns.FacetGrid and sns.heatmap, so some options don't work in one function or the other. I will check how other functions handle this.

EDIT: Ok seeing gridmap, I have for instance: im = plot_data.plot.pcolormesh(**plot_kw)
and plot_kw can also contain "col/row" keywords in this context.

Simply put, xr.plot.pcolormesh(da, col="time") works, but not sns.heatmap(da, col="time").

sarahclaude · 2024-06-12T20:22:56Z

Usually plot_kw allows you to access the function argument of the xarray plot which also allows the xarray facetgrid arguments.

However, it doesn't always work well and this is why I put some warnings with fig_kw and facetgrids that not all options are available. I think if you add a warning saying only col and row are accepted for the seaborn faccetgrid options in plot_kw it will work great.

coxipi · 2024-06-12T20:25:15Z

Here is my hacky solution, just look at allowed keywords for each function

        kws_hm = set(inspect.signature(sns.heatmap).parameters)
        kws_fg = set(inspect.signature(sns.FacetGrid).parameters)
        plot_kw_keys = list(plot_kw.keys())
        plot_kw_fg = {k: v for k, v in plot_kw.items() if k in kws_fg.intersection(plot_kw_keys)}
        plot_kw_hm = {k: v for k, v in plot_kw.items() if k in kws_hm.intersection(plot_kw_keys)}
# then use plot_kw_fg for sns.FacetGrid, and plot_kw_hm for sns.heatmap

# height is only sns.FacetGrid, cmap is only sns.heatmap
fg.heatmap(da, plot_kw = {"col": "time", "height":6, "cmap":"Spectral_r"})

coxipi · 2024-06-13T16:07:16Z

src/figanos/matplotlib/plot.py

+        # When using xarray's FacetGrid, `plot_kw` can be used in the FacetGrid and in the plotting function
+        # With Seaborn, we need to be more careful and separate keywords.
+        plot_kw_hm = {
+            k: v for k, v in plot_kw.items() if k in signature(sns.heatmap).parameters
+        }
+        plot_kw_fg = {
+            k: v for k, v in plot_kw.items() if k in signature(sns.FacetGrid).parameters
+        }
+        unused_keys = (
+            set(plot_kw.keys()) - set(plot_kw_fg.keys()) - set(plot_kw_hm.keys())
+        )
+        if unused_keys != set():
+            raise ValueError(
+                f"`heatmap` got unexpected keywords in `plot_kw`: {unused_keys}. Keywords in `plot_kw` should be keywords "
+                "allowed in `sns.heatmap` or `sns.FacetGrid`. "
+            )


Just want to highlight this: This ensures we can use both keywords from heatmap and FacetGrid. With this approach, we would silently ignore wrong keywords, so I have to find if there are unused_keys and if so, add an extra step to throw an error.

A solution to avoid this extra step would be to stuff in illegal keywords in plot_kw_fg for instance, then sns.FacetGrid would handle the error management. But since plot_kw allows for both keywords on FacetGrid and Heatmap, I thought it was better to have our own explicit error message, since we have this peculiar input.

coxipi · 2024-06-13T19:02:22Z

src/figanos/matplotlib/plot.py

+            # Any sorting should be performed before sending a DataArray in `fg.heatmap`
+            else data.pivot_table(
+                index=args[1], columns=args[0], values=args[2], sort=False
+            )


Columns/Rows of individual heatmap are not sorted by pandas in this way. This should be managed by sorting directly the input dataset, I think it's reasonable. Otherwise, it's difficult to manage custom order of coords values in the heatmap.

sarahclaude

Looks great, thanks Eric!

coxipi · 2024-07-10T14:40:26Z

src/figanos/matplotlib/plot.py

+        cax = g.fig.add_axes([0.95, 0.05, 0.02, 0.9])
+        g.map_dataframe(
+            draw_heatmap, *heatmap_dims, da_name, **plot_kw_hm, cbar=True, cbar_ax=cax
+        )
+        g.fig.subplots_adjust(right=0.9)


I tried giving sane defaults to the cax position. I think FacetGrids in xarray handle this better, no need to specify an absolute position. In any case, it can be changed afterwards it this is needed.

coxipi · 2024-07-11T01:28:00Z

Oops, I realized I had not pushed a final commit (one line of code) in my github branch @Zeitsperre anything I could do that doesn't involve simply a new PR? I guess not? Sorry about that

Allow FacetGrids use in heatmaps

b94cb5e

coxipi added 2 commits June 10, 2024 18:07

update CHANGELOG

94eb74e

respect convention: issue first, pull after

bb1fde5

coxipi mentioned this pull request Jun 10, 2024

Support grid of heatmaps #208

Open

1 task

sarahclaude reviewed Jun 11, 2024

View reviewed changes

warn, only use figsize with facetgrid

49afac7

coxipi commented Jun 11, 2024

View reviewed changes

coxipi added 3 commits June 12, 2024 16:54

split plot_kw in kws for FacetGrid and heatmap

b9417de

warning if illegal plot keys are used

f9a368a

warning -> error

d4dad67

coxipi commented Jun 13, 2024

View reviewed changes

no sorting in the heatmap function

20834e3

coxipi commented Jun 13, 2024

View reviewed changes

coxipi added 2 commits June 19, 2024 09:34

change cax config

f1812b8

Merge branch 'main' of github.com:Ouranosinc/figanos into heatmap_array

cedd621

sarahclaude approved these changes Jun 21, 2024

View reviewed changes

coxipi commented Jul 10, 2024

View reviewed changes

coxipi merged commit b8811a6 into main Jul 10, 2024
12 checks passed

coxipi deleted the heatmap_array branch July 10, 2024 14:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow FacetGrids use in heatmaps #219

Allow FacetGrids use in heatmaps #219

coxipi commented Jun 10, 2024 •

edited

Loading

review-notebook-app bot commented Jun 10, 2024

sarahclaude left a comment

coxipi Jun 11, 2024 •

edited

Loading

sarahclaude Jun 12, 2024

coxipi commented Jun 12, 2024 •

edited

Loading

sarahclaude commented Jun 12, 2024

coxipi commented Jun 12, 2024 •

edited

Loading

coxipi Jun 13, 2024 •

edited

Loading

coxipi Jun 13, 2024

sarahclaude left a comment

coxipi Jul 10, 2024

coxipi commented Jul 11, 2024 •

edited

Loading

Allow FacetGrids use in heatmaps #219

Allow FacetGrids use in heatmaps #219

Conversation

coxipi commented Jun 10, 2024 • edited Loading

Pull Request Checklist:

What kind of change does this PR introduce?

Does this PR introduce a breaking change?

Other information:

review-notebook-app bot commented Jun 10, 2024

sarahclaude left a comment

Choose a reason for hiding this comment

coxipi Jun 11, 2024 • edited Loading

Choose a reason for hiding this comment

sarahclaude Jun 12, 2024

Choose a reason for hiding this comment

coxipi commented Jun 12, 2024 • edited Loading

sarahclaude commented Jun 12, 2024

coxipi commented Jun 12, 2024 • edited Loading

coxipi Jun 13, 2024 • edited Loading

Choose a reason for hiding this comment

coxipi Jun 13, 2024

Choose a reason for hiding this comment

sarahclaude left a comment

Choose a reason for hiding this comment

coxipi Jul 10, 2024

Choose a reason for hiding this comment

coxipi commented Jul 11, 2024 • edited Loading

coxipi commented Jun 10, 2024 •

edited

Loading

coxipi Jun 11, 2024 •

edited

Loading

coxipi commented Jun 12, 2024 •

edited

Loading

coxipi commented Jun 12, 2024 •

edited

Loading

coxipi Jun 13, 2024 •

edited

Loading

coxipi commented Jul 11, 2024 •

edited

Loading