muon.atac.tl.rank_peaks_groups
muon.atac.tl.rank_peaks_groups#
- muon.atac.tl.rank_peaks_groups(data: Union[anndata._core.anndata.AnnData, mudata._core.mudata.MuData], groupby: str, add_peak_type: bool = False, add_distance: bool = False, **kwargs)#
Rank peaks in clusters groups.
Shorthand for running sc.tl.rank_genes_groups followed by muon.atac.tl.add_genes_peaks_groups.
See sc.tl.rank_genes_groups for details.
- Parameters
data (Union[AnnData, MuData]) – AnnData object with peak counts or MuData object with ‘atac’ modality.
groupby (str) – The key of the observations grouping to consider.
add_peak_type (bool (False by default)) – If to add peak type to the ranked peaks per group
add_distance (bool (False by default)) – If to add distance to the ranked peaks per group