gretapy.pl.heatmap

Contents

gretapy.pl.heatmap#

gretapy.pl.heatmap(df, level='edge', order=None, title=None, cmap='Purples', vmin=0, vmax=1, width=2, height=2, **kwargs)#

Plot overlap coefficient heatmap.

Parameters:

  • df (DataFrame) – Output from tl.ocoeff with columns: grn_a, grn_b, source, cre, target, edge.

  • level (str (default: 'edge')) – Which level to plot: “source”, “cre”, “target”, or “edge”. Default is “edge”.

  • order (list | None (default: None)) – Order of GRN names for rows/columns. If None, uses alphabetical order.

  • title (str | None (default: None)) – Title for the heatmap. If None, uses the level name.

  • cmap (str (default: 'Purples')) – Colormap name. Default is “Purples”.

  • vmin (float (default: 0)) – Minimum value for colormap. Default is 0.

  • vmax (float (default: 1)) – Maximum value for colormap. Default is 1.

  • width (float (default: 2)) – Width of the heatmap in marsilea units. Default is 2.

  • height (float (default: 2)) – Height of the heatmap in marsilea units. Default is 2.

  • **kwargs – Additional arguments passed to decoupler.Plotter (e.g. figsize, dpi, return_fig, save).

Return type:

Figure | None

Returns:

plt.Figure or None Figure if return_fig=True.

Contents