metobs_toolkit.analysis.Analysis.plot_correlation_heatmap#

Analysis.plot_correlation_heatmap(groupby_value=None, title=None, _return_ax=False)[source]#

Make a heatmap plot af a correaltion matrix.

To specify which correlation matrix to plot, specify the group value using the groupby_value argument.

All possible groupby_values are the keys of the lc_cor_dict attribute.

Parameters:
  • groupby_value (str, num, None, optional) – A groupby value to indicate which correlation matrix to visualise. If None is given, the first groupby value that is present is chosen.The default is None.

  • title (str, optional) – Title of the figure. If None, a default title is constructed.The default is None.

Return type:

None.

Note

To list all possible groupby_values, one can use ` print(Analysis_instance.lc_cor_dict.keys())`