muon.atac.tl.add_peak_annotation_gene_names

muon.atac.tl.add_peak_annotation_gene_names(data, gene_names=None, join_on=None, return_annotation=False)

Add gene names to peak annotation table in .uns[“atac”][“peak_annotation”].

Parameters:

• data (AnnData | MuData) – AnnData object with peak counts or multimodal MuData object with ‘atac’ modality.

• gene_names (DataFrame | None (default: None)) – A DataFrame indexed on the gene name

• join_on (str | None (default: None)) – 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 (bool (default: False)) – Whether to return adata.uns[‘atac’][‘peak_annotation’]. False by default.

Return type:

DataFrame | None