liana.plotting.dotplot_by_sample

liana.plotting.dotplot_by_sample#

liana.plotting.dotplot_by_sample(adata=None, uns_key='liana_res', liana_res=None, sample_key='sample', colour=None, size=None, inverse_colour=False, inverse_size=False, source_labels=None, target_labels=None, ligand_complex=None, receptor_complex=None, size_range=(2, 9), cmap='viridis', figure_size=(8, 6), return_fig=True)#

A dotplot of interactions by sample

Parameters:

  • adata (AnnData (default: None))

  • object. (bool whether to return the fig)

  • uns_key (str (default: 'liana_res'))

  • 'liana_res'. (Key in adata.uns that contains the LIANA results. Default is)

  • liana_res (DataFrame (default: None))

  • format. (liana_res a DataFrame in liana's)

  • sample_key (str (default: 'sample')) – sample_key used to group different samples/contexts from liana_res. Defaults to ‘sample’.

  • colour (str (default: None))

  • dots. (column in liana_res to define the size of the)

  • size (y)

  • dots.

  • inverse_colour (bool (default: False))

  • default. (Whether to -log10 the size column for plotting. False by)

  • inverse_size (bool (default: False))

  • default.

  • source_labels (str | None (default: None))

  • source (List of labels to use as)

  • out. (the rest are filtered)

  • target_labels (str | None (default: None))

  • target (List of labels to use as)

  • out.

  • ligand_complex (list[str] | str | None (default: None))

  • None. (list of receptor complexes to filter the interactions to be plotted. Defaults to)

  • receptor_complex (list[str] | str | None (default: None))

  • None.

  • size_range (tuple[float, float] (default: (2, 9)))

  • (min (Define size range. Tuple of)

  • integers. (max))

  • cmap (str (default: 'viridis'))

  • plotting. (Colour map to use for)

  • figure_size (tuple[float, float] (default: (8, 6)))

  • x (Figure)

  • size

  • return_fig (bool (default: True))

  • object.

Return type:

Figure

Returns:

Returns a dot plot for the specified interactions by sample.