anndict.plot.plot_model_agreement

anndict.plot.plot_model_agreement(adata, group_by, sub_group_by, agreement_cols, granularity=2, legend=False)

Plots the average values of specified agreement columns across varying levels of granularity. See notes for which columns are ignored based on the granularity setting.

Parameters:

adata AnnData

an AnnData.

group_by str

Column name in adata.obs for the main grouping (e.g., 'cell_type').

sub_group_by str

Column name in adata.obs for the sub-grouping (e.g., 'tissue').

agreement_cols list[str]

Column names specifying the agreement columns (e.g., ['agreement_of_manual_with_model1', 'agreement_of_manual_with_model2']).

granularity int (default: 2)

Level of detail in the plot (0 = models only, 1 = models within cell types, 2 = models within cell types and tissues).

legend bool (default: False)

If True and if granularity=2, adds a legend for sub_group_by.

Return type:

tuple[Figure, Axes] | ClusterGrid

Returns:

The plot of agreement, averaged according to the granularity setting.

Notes

If granularity is 0, group_by and sub_group_by are not used. If granularity is 1, sub_group_by is not used.

Examples

import anndict as adt
adt.plot_model_agreement(adata, 'cell_type', 'tissue', ['agreement_of_manual_with_model1', 'agreement_of_manual_with_model2'], granularity=0)