muon.atac.tl.add_peak_annotation_gene_names
muon.atac.tl.add_peak_annotation_gene_names#
- muon.atac.tl.add_peak_annotation_gene_names(data: Union[anndata._core.anndata.AnnData, mudata._core.mudata.MuData], gene_names: Optional[pandas.core.frame.DataFrame] = None, join_on: Optional[str] = None, return_annotation: bool = False)#
Add gene names to peak annotation table in .uns[“atac”][“peak_annotation”]
- Parameters
data – AnnData object with peak counts or multimodal MuData object with ‘atac’ modality.
gene_names – A DataFrame indexed on the gene name
join_on – Name of the column in the gene_names DataFrame corresponding to the peak annotation index. It is automatically set to “gene_ids” or “gene_name” if none is provided.
return_annotation – If return adata.uns[‘atac’][‘peak_annotation’]. False by default.