Metabolic cell-cell communication inference in spatial transcriptomics.
Project description
Harreman
Harreman is an algorithm and open-source software for inference of metabolic exchanges in tissues using spatial transcriptomics. Harreman employs a series of spatial correlation statistics to enable multiscale insight: from stratification of tissues into regions with different metabolic characteristics, to inference of which metabolites are exchanged within each region, and to identification of the specific subsets of cells that are exchanging these metabolites (through import and export reactions).
Resources
- Tutorials, user guide, API reference, installation guide, and release notes are available in the Documentation.
Installation
We suggest using a package manager like conda or mamba to install the package.
conda create -n harreman-env python=3.12
conda activate harreman-env
pip install harreman
Tutorials
- For tutorials on how to run the PyTorch version of Hotspot with Harreman, visit the Hotspot tutorials.
- To get familiar with the Harreman pipeline on the case studies used in the manuscript, visit the Harreman tutorials.
Test statistics
All test statistics available in the Harreman pipeline are described in the User guide. Currently implemented test statistics are:
- Test statistic 1: Is gene a spatially autocorrelated?
- Test statistic 2: Are genes a and b spatially co-localized (or interacting with each other)?
- Test statistic 3: Is metabolite m spatially autocorrelated?
- Test statistic 4: Are metabolites $m_1$ and $m_2$ spatially co-localized?
- Test statistic 5: Do genes a and b interact when expressed by cell types t and u, respectively?
- Test statistic 6: Is metabolite m exchanged by cell types t and u?
- Test statistic 7: Do genes a and b interact when a is expressed by cell i and b by spatially nearby cells?
- Test statistic 8: Is metabolite m exchanged by cell i and other spatially proximal cells?
- Test statistic 9: Do genes a and b interact when a is expressed by cell i (that belongs to cell type t) and b by spatially nearby cells (that belong to cell type u)?
- Test statistic 10: Is metabolite m exchanged by cell i (that belongs to cell type t) and other spatially proximal cells (that belong to cell type u)?
Reference
- Metabolic zonation and characterization of tissue slices with spatial transcriptomics. bioRxiv, 2025. https://doi.org/10.1101/2025.11.11.687271
Project details
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 harreman-0.1.3.tar.gz.
File metadata
- Download URL: harreman-0.1.3.tar.gz
- Upload date:
- Size: 509.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3bf67b999759ac4973669b4d7438b270991fddc05e7f52a6b5633f3c3602e71d
|
|
| MD5 |
d03b518266c47dbb816f29721b027610
|
|
| BLAKE2b-256 |
e2d3b03c96837266374d6bf12466d324f7a2bf56df86aa0563edc1d1ad435f9e
|
Provenance
The following attestation bundles were made for harreman-0.1.3.tar.gz:
Publisher:
release.yml on YosefLab/Harreman
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
harreman-0.1.3.tar.gz -
Subject digest:
3bf67b999759ac4973669b4d7438b270991fddc05e7f52a6b5633f3c3602e71d - Sigstore transparency entry: 701222249
- Sigstore integration time:
-
Permalink:
YosefLab/Harreman@94ed41ebbf6ef6d4c7b0ab4d1c6fd0e3015b77a7 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/YosefLab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@94ed41ebbf6ef6d4c7b0ab4d1c6fd0e3015b77a7 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file harreman-0.1.3-py3-none-any.whl.
File metadata
- Download URL: harreman-0.1.3-py3-none-any.whl
- Upload date:
- Size: 540.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db27e0f35e3cf8a0aa8d85e6f0f4dffa335b0c3d3e897f9317f530d9bac24774
|
|
| MD5 |
2d51bcdcebedaf6c564d04b5fbc5051c
|
|
| BLAKE2b-256 |
ffae2605e3f3034c5e7ac129e2b13603a32c8c4f141ce0a5a326ee000a978b67
|
Provenance
The following attestation bundles were made for harreman-0.1.3-py3-none-any.whl:
Publisher:
release.yml on YosefLab/Harreman
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
harreman-0.1.3-py3-none-any.whl -
Subject digest:
db27e0f35e3cf8a0aa8d85e6f0f4dffa335b0c3d3e897f9317f530d9bac24774 - Sigstore transparency entry: 701222258
- Sigstore integration time:
-
Permalink:
YosefLab/Harreman@94ed41ebbf6ef6d4c7b0ab4d1c6fd0e3015b77a7 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/YosefLab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@94ed41ebbf6ef6d4c7b0ab4d1c6fd0e3015b77a7 -
Trigger Event:
workflow_dispatch
-
Statement type: