liana.plotting.dotplot#
- liana.plotting.dotplot(adata=None, uns_key='liana_res', liana_res=None, colour=None, size=None, source_labels=None, target_labels=None, top_n=None, orderby=None, orderby_ascending=None, orderby_absolute=False, filter_fun=None, ligand_complex=None, receptor_complex=None, inverse_colour=False, inverse_size=False, cmap='viridis', size_range=(2, 9), figure_size=(8, 6), return_fig=True)#
Dotplot interactions by source and target cells
- Parameters:
adata (
AnnData(default:None)) – Annotated data object.uns_key (
str(default:'liana_res')) – Key inadata.unsthat contains the LIANA results. Default is'liana_res'.liana_res (
DataFrame(default:None)) –liana_resaDataFramein liana’s format.colour (
str(default:None)) –columninliana_resto define the colours of the dots.size (
str(default:None)) –columninliana_resto define the size of the dots.source_labels (
list[str] (default:None)) – List of labels to use assource, the rest are filtered out.target_labels (
list[str] (default:None)) – List of labels to use astarget, the rest are filtered out.top_n (
int(default:None)) –top_nentities to plot.orderby (
str|None(default:None)) – Iftop_nis notNone, order the interactions by this columnorderby_ascending (
bool|None(default:None)) – Iftop_nis notNone, specify how to order the interactionsorderby_absolute (
bool(default:False)) – Iftop_nis notNone, whether to order by the absolute value of theorderbycolumn.filter_fun (
Callable(default:None)) – A function, applied along the columns (axis=1), used to filter the results to be plotted.ligand_complex (
str|None(default:None)) –listof ligand complexes to filter the interactions to be plotted. Defaults to None.receptor_complex (
str|None(default:None)) –listof receptor complexes to filter the interactions to be plotted. Defaults to None.inverse_colour (
bool(default:False)) – Whether to -log10 thecolourcolumn for plotting.Falseby default.inverse_size (
bool(default:False)) – Whether to -log10 thesizecolumn for plotting.Falseby default.cmap (
str(default:'viridis')) – Colour map to use for plotting.size_range (
tuple[float,float] (default:(2, 9))) – Define size range. Tuple of (min, max) integers.figure_size (
tuple[float,float] (default:(8, 6))) – Figure x,y sizereturn_fig (
bool(default:True)) –boolwhether to return the fig object.
- Return type:
Figure- Returns:
The resulting dotplot