Skip to main content

Metabolic cell-cell communication inference in spatial transcriptomics.

Project description

Harreman

License Stars PyPI Harreman Coverage Code Style Downloads Docs

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).

overview

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

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

harreman-0.1.3.tar.gz (509.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

harreman-0.1.3-py3-none-any.whl (540.6 kB view details)

Uploaded Python 3

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

Hashes for harreman-0.1.3.tar.gz
Algorithm Hash digest
SHA256 3bf67b999759ac4973669b4d7438b270991fddc05e7f52a6b5633f3c3602e71d
MD5 d03b518266c47dbb816f29721b027610
BLAKE2b-256 e2d3b03c96837266374d6bf12466d324f7a2bf56df86aa0563edc1d1ad435f9e

See more details on using hashes here.

Provenance

The following attestation bundles were made for harreman-0.1.3.tar.gz:

Publisher: release.yml on YosefLab/Harreman

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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

Hashes for harreman-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 db27e0f35e3cf8a0aa8d85e6f0f4dffa335b0c3d3e897f9317f530d9bac24774
MD5 2d51bcdcebedaf6c564d04b5fbc5051c
BLAKE2b-256 ffae2605e3f3034c5e7ac129e2b13603a32c8c4f141ce0a5a326ee000a978b67

See more details on using hashes here.

Provenance

The following attestation bundles were made for harreman-0.1.3-py3-none-any.whl:

Publisher: release.yml on YosefLab/Harreman

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page