Ctrl+K

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: AnnData | MuData, gene_names: DataFrame | None = None, join_on: 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.

Contents