snapatac2.pl.regions

snapatac2.pl.regions(adata, groupby, peaks, width=600, height=400, show=True, interactive=True, out_file=None)

Parameters:

• adata (AnnData | AnnDataSet) – Annotated data matrix.

• groupby (str | list[str]) – Group the cells into different groups. If a str, groups are obtained from .obs[groupby].

• peaks (dict[str, list[str]]) – Peaks of each group.

• width (float) – The width of the plot

• height (float) – The height of the plot

• show (bool) – Show the figure

• interactive (bool) – Whether to make interactive plot

• out_file (str | None) – Path of the output file for saving the output image, end with ‘.svg’ or ‘.pdf’ or ‘.png’ or ‘.html’.

Returns:

If show=False and out_file=None, an plotly.graph_objects.Figure will be returned, which can then be further customized using the plotly API.

Return type:

‘plotly.graph_objects.Figure’ | None