Batch-aware, SVD-based pathway-activity inference for single-cell transcriptomics, natively integrated with the Scanpy/AnnData ecosystem. scROMA is a Python implementation of ROMA (Representation and Quantification Of Module Activity) that scores each gene set from the coordinated variation among its member genes, with per-cell activity scores, per-gene contributions, and permutation-based significance. Its batch-aware extension corrects technical variation inside the gene-set subspace rather than across the whole transcriptome, and it ships with a generative simulation framework that produces data with fully specified ground-truth pathway activity.
Install
pip install scroma
# or with uv:
uv pip install scroma # into the active environment
uv add scroma # into a uv project
Requires Python ≥ 3.10 and anndata ≥ 0.12. Tutorial datasets download on first use (via pooch).
Quick start
import scroma
# --- core pathway-activity scoring ---
adata = scroma.datasets.pbmc3k() # downloaded + cached on first use
roma = scroma.ROMA()
roma.adata = adata
roma.gmt = scroma.use_hallmarks() # bundled MSigDB Hallmark gene sets
roma.compute()
roma.summary() # significantly active pathways
# --- batch-aware scoring (correction within the gene-set subspace) ---
broma = scroma.BatchAwareROMA()
broma.adata = adata
broma.gmt = scroma.use_hallmarks()
broma.compute(batch_key="batch", batch_method="harmonylike")
# --- simulation with ground-truth pathway activity ---
sim = scroma.simulate(n_batches=3, seed=42) # AnnData + ground truth in .obsm/.uns
reps = scroma.load_benchmark("multi") # 10 default benchmark replicates
Features
- Two complementary scores per gene set: an L1 overdispersion score and a median-expression shift score, plus per-cell activity scores and per-gene contribution weights.
- Permutation significance with Benjamini–Hochberg correction.
- Batch-aware correction within each gene set (
residualized,contrastive,weighted,centered,ComBat,MNN,harmonylike). - Ground-truth simulator (
scroma.simulate/scroma.load_benchmark) for quantitative benchmarking. - Bundled gene sets (
use_hallmarks,use_reactome,use_progeny) and one-call tutorial datasets (datasets.pbmc3k,datasets.pbmc_ifnb).
Documentation
Full docs and tutorials: https://scroma.readthedocs.io
- Getting started — scoring pathway activity on PBMCs
- Simulated data — visualising ground truth and computing AUROC
- Gene-set weights — which genes drive a pathway
- Pathway-activity clustermap
Citing scROMA
If you use scROMA, please cite the paper (see CITATION.cff).
License
scROMA is released under the GNU GPL v3.
1 maintainer
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 scroma-0.3.3.tar.gz.
File metadata
- Download URL: scroma-0.3.3.tar.gz
- Upload date:
- Size: 379.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
295fd857d226e819d4706b77f7c147847398f7c2519f86a9c721ff1afb42f0ec
|
|
| MD5 |
c3f114a3f71e3367aa74ffb1816209f9
|
|
| BLAKE2b-256 |
678440940ce2a1822e090cbb5fd45d76afa6f34ad7b01b6de1361060f753143e
|
Provenance
The following attestation bundles were made for scroma-0.3.3.tar.gz:
Publisher:
release.yml on sysbio-curie/scroma
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
scroma-0.3.3.tar.gz -
Subject digest:
295fd857d226e819d4706b77f7c147847398f7c2519f86a9c721ff1afb42f0ec - Sigstore transparency entry: 2359446883
- Sigstore integration time:
-
Permalink:
sysbio-curie/scroma@4dcf5509075d8e216de983fa65dbe751256f88e7 -
Branch / Tag:
refs/tags/v0.3.3 - Owner: https://github.com/sysbio-curie
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4dcf5509075d8e216de983fa65dbe751256f88e7 -
Trigger Event:
push
-
Statement type:
File details
Details for the file scroma-0.3.3-py3-none-any.whl.
File metadata
- Download URL: scroma-0.3.3-py3-none-any.whl
- Upload date:
- Size: 377.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
76527346512c281565d135d5ab36ce9821e94500ec5bdd2265ff03154544a28b
|
|
| MD5 |
39e3098a041bd881e9e7263f2db32c7c
|
|
| BLAKE2b-256 |
78357f785f3631dc511f9e8aaa2bae95d81a4511f7c6e60a3e145c81d2fc0936
|
Provenance
The following attestation bundles were made for scroma-0.3.3-py3-none-any.whl:
Publisher:
release.yml on sysbio-curie/scroma
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
scroma-0.3.3-py3-none-any.whl -
Subject digest:
76527346512c281565d135d5ab36ce9821e94500ec5bdd2265ff03154544a28b - Sigstore transparency entry: 2359446953
- Sigstore integration time:
-
Permalink:
sysbio-curie/scroma@4dcf5509075d8e216de983fa65dbe751256f88e7 -
Branch / Tag:
refs/tags/v0.3.3 - Owner: https://github.com/sysbio-curie
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4dcf5509075d8e216de983fa65dbe751256f88e7 -
Trigger Event:
push
-
Statement type:
