EnrichMap: Spatially informed enrichment analysis for functional interpretation of spatial transcriptomics
Project description
EnrichMap: Spatially-aware gene set enrichment
EnrichMap is a lightweight tool designed to compute and visualise enrichment scores of a given gene set or signature in spatial transcriptomics datasets across different platforms. It offers flexible scoring, batch correction, spatial smoothing and visual outputs for intuitive exploration of biological signatures.
Features
- Fast computation of enrichment scores
- Support for batch correction and spatial covariates
- Built-in spatial smoothing
- Visualisation tools for intuitive mapping
- Easy integration with AnnData (.h5ad) objects
Installation
A conda environment is strongly recommended with python ≥ 3.10.
conda create -n enrichmap_env python=3.11
conda activate enrichmap_env
Then, install enrichmap via pip.
pip install enrichmap
or directly from GitHub:
pip install git+https://github.com/secrierlab/enrichmap.git
Basic usage
import scanpy as sc
import enrichmap as em
# Load your AnnData object
adata = sc.read_h5ad("PATH/TO/YOUR/DATA.h5ad")
# Define a gene set
gene_set = ["CD3D", "CD3E", "CD8A"]
# Run scoring
em.tl.score(
adata=adata,
gene_set=gene_set,
score_key="T_cell_signature",
smoothing=True, # by default,
correct_spatial_covariates=True, # by default
batch_key=None # Set batch_key if working with multiple slides
)
# Visualise
em.pl.spatial_enrichmap(
adata=adata,
score_key="T_cell_signature_score"
)
Important note: EnrichMap currently does not support reading in
SpatialDataformat. However, users can simply convertSpatialDatato legacyAnnDatato use EnrichMap.
import spatialdata_io as sd
# read in SpatialData
sdata = sd.visium_hd("PATH_TO_DATA_FOLDER/")
# convert to AnnData
adata = to_legacy_anndata(sdata, include_images=True, table_name="square_008um", coordinate_system="downscaled_hires")
Documentation
Comprehensive documentation is available at: https://enrichmap.readthedocs.io/en/latest
Contributing
If you have ideas for new features or spot a bug, please open an issue or submit a pull request.
License
This project is licensed under the GNU GENERAL PUBLIC LICENSE.
Citation
Celik C & Secrier M (2025). EnrichMap: Spatially-informed enrichment analysis for functional interpretation of spatial transcriptomics. biorxiv.com
Copyright
This code is free and is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. See the GNU General Public License for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file enrichmap-0.1.23.tar.gz.
File metadata
- Download URL: enrichmap-0.1.23.tar.gz
- Upload date:
- Size: 75.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9193f71fa1847e502ea8ddf48f296a4265c461eec4e0509a74088e5be6d668e3
|
|
| MD5 |
c8636b13f3232e655001e0d3a4b70aaf
|
|
| BLAKE2b-256 |
676628662fa863dcd56d0ea269c0a7c3d06860d744f26fe4d90c16131a34063f
|
File details
Details for the file enrichmap-0.1.23-py3-none-any.whl.
File metadata
- Download URL: enrichmap-0.1.23-py3-none-any.whl
- Upload date:
- Size: 41.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1621058f3a169dc4b60b7a10ea6aa52196eae460632319121fa5b6b8dee48411
|
|
| MD5 |
16a1b78107bfd0921c9e7bfc51c242e6
|
|
| BLAKE2b-256 |
ad0b4bdc210ba5602888e19a0ff499f60bfde877abf94d24f889e707176da925
|