raphael-group / DeST_OT

Developmental Spatiotemporal Optimal Transport

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DeST_OT

Developmental SpatioTemporal Optimal Transport

figure_1

A method for aligning spatially resolved transcriptomics time-series.

There are four main functions:

  1. src/destot/DESTOT/align: Given a pair of ST slices from two developmental timepoints, infer a spatiotemporal alignment matrix Pi and a growth vector xi. As discussed in the paper, there are two settings we recommend for this function: the default setting for growth-rates and alignments ($\alpha = 0.2$, $\beta = 0.5$, $\gamma = 50$, $\epsilon = 0.1$), and the robust setting ($\alpha = 0.99$, $\beta = 0.6$, $\gamma = 1$, $\epsilon = 0.1$) for spatiotemporal alignments with very different geometries (e.g. with capture-frame effects).
  2. src/destot/DESTOT/xi_to_growth_rate: Given a growth vector xi, convert the values in the growth vector to a per-spot growth rate $J$ given the start and end timepoints.
  3. src/destot/metrics/growth_distortion_metric: Given a pair of ST slices, their spatiotemporal alignment matrix Pi, and the inferred growth vector xi, calculcate the growth distortion metric as in Eq. 9 of the paper.
  4. src.destot/metrics/migration_metric: Given a pair of ST slices and their spatiotemporal alignment matrix Pi, calculate the migration metric as in Eq. 11 of the paper.

Installation

We will soon make DeST-OT available on PyPi. In the mean time, you can download the repository and call the functions directly.

Contact

If you encounter any problem running the software, please contact Xinhao Liu at xl5434@princeton.edu or Peter Halmos at ph3641@princeton.edu

Reference

Halmos, P., Liu, X., Gold, J., Chen, F., Ding, L. & Raphael, B. J. (2024). DeST-OT: Alignment of Spatiotemporal Transcriptomics Data. bioRxiv. The journal version is under review and the citation will be updated once published.

The bioRxiv version is available here: https://www.biorxiv.org/content/10.1101/2024.03.05.583575v1

About

Developmental Spatiotemporal Optimal Transport

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Jupyter Notebook 98.3%Language:Python 1.7%