pairot.pl.sankey

Contents

pairot.pl.sankey#

pairot.pl.sankey(cluster_mapping, cluster_distance, filter_threshold=0.25, width=None, height=None)#

Plot cluster mappings and distances from pairot.tl.DatasetMap as a Sankey diagram.

Parameters:

  • cluster_mapping (DataFrame) – pd.DataFrame containing the cluster mapping scores.

  • cluster_distance (DataFrame) – pd.DataFrame containing the cluster distances.

  • filter_threshold (float (default: 0.25)) – Minimum mapping score to include a link in the Sankey diagram.

  • width (int (default: None)) – Width of the plot in pixels.

  • height (int (default: None)) – Height of the plot in pixels.

Examples

>>> import pairot as pr
>>>
>>> # Get cluster mappings between query and reference dataset
>>> mapping = dataset_map.compute_mapping()
>>> # Get cluster distances between query and reference dataset
>>> distance = dataset_map.compute_distance()
>>> pr.pl.sankey(
>>>     mapping,
>>>     distance,
>>>     filter_threshold=0.25,  # only show links with mapping score >= 0.25
>>> )
Contents