stlearn.pl.cci_map

stlearn.pl.cci_map(adata: AnnData, use_label: str, lr: Optional[str] = None, ax: Optional[Axes] = None, show: bool = False, figsize: Optional[tuple] = None, cmap: str = 'Spectral_r', sig_interactions: bool = True, title=None)[source]

Heatmap visualising sender->receivers of cell type interactions.

Parameters:

  • adata (AnnData) – Data on which st.tl.cci.run & st.tl.cci.run_cci has been applied.

  • use_label (str) – Indicates the cell type labels or deconvolution results used for cell-cell interaction counting by LR pairs.

  • lr (str) – The LR pair to visualise the sender->receiver interactions for. If None, will use all pairs via adata.uns[f’lr_cci_{use_label}’].

  • ax (Axes) – Axes on which to plot the heatmap, if None then generates own.

  • show (bool) – Whether to show the plot or not; if not, then returns ax.

  • figsize (tuple) – (width, height), specifies the dimensions of the figure. Only relevant if ax=None.

  • cmap (str) – Cmap used to color the number of LR interactions.

  • sig_interactions (bool) – Whether to only show significant CCIs, or all observed interactions.

  • title (None) – Title to display over the heatmap. If not provided, will be determined based on the run parameters.

Returns:

ax – Axes where the heatmap was drawn if show=False.

Return type:

matplotlib.figure.Axes