grassp.pl.remodeling_sankey

grassp.pl.remodeling_sankey#

remodeling_sankey(data, data2, cluster_key='leiden', ax=None, aspect=20, fontsize=12, figsize=(10, 11), show=None, save=None)[source]#

Sankey diagram of cluster re-assignment between two conditions.

Parameters:
data AnnData

Two AnnData objects with identical observation indices and a categorical cluster_key in .obs.

data2 AnnData

Two AnnData objects with identical observation indices and a categorical cluster_key in .obs.

cluster_key str (default: 'leiden')

Column name that encodes cluster memberships.

aspect int (default: 20)

Styling options passed to pysankey.sankey() or matplotlib.

fontsize int (default: 12)

Styling options passed to pysankey.sankey() or matplotlib.

figsize tuple[float, float] (default: (10, 11))

Styling options passed to pysankey.sankey() or matplotlib.

ax Axes | None (default: None)

Styling options passed to pysankey.sankey() or matplotlib.

show bool | None (default: None)

Behaviour identical to other plotting functions.

save bool | str | None (default: None)

Behaviour identical to other plotting functions.

Return type:

Axes | None

Returns:

Axes containing the Sankey plot if show is False.