Skip to content

YosefLab/Harreman

Repository files navigation

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

About

Harreman infers metabolic exchanges in tissues using spatial transcriptomics.

Resources

License

Stars

Watchers

Forks

Languages