azizilab / starfysh

Spatial Transcriptomic Analysis using Reference-Free auxiliarY deep generative modeling and Shared Histology
BSD 3-Clause "New" or "Revised" License
87 stars 12 forks source link

Documentation Status Licence: GPL v3 Open In Colab

Starfysh: Spatial Transcriptomic Analysis using Reference-Free deep generative modeling with archetYpes and Shared Histology

Starfysh is an end-to-end toolbox for the analysis and integration of Spatial Transcriptomic (ST) datasets. In summary, the Starfysh framework enables reference-free deconvolution of cell types and cell states and can be improved with the integration of paired histology images of tissues, if available. Starfysh is capable of integrating data from multiple tissues. In particular, Starfysh identifies common or sample-specific spatial “hubs” with unique composition of cell types. To uncover mechanisms underlying local and long-range communication, Starfysh can be used to perform downstream analysis on the spatial organization of hubs.

Quickstart tutorials

Tutorials on Colab (recommend)

Please refer to Starfysh Documentation for additional tutorials & APIs

Installation

Github-version installation:

# Step 1: Clone the Repository
git clone https://github.com/azizilab/starfysh.git

# Step 2: Navigate to the Repository
cd starfysh

# Step 3: Install the Package
pip install .

PyPI release:

pip install starfysh

Model Input:

Features:

Directories

.
├── data:           Spatial Transcritomics & synthetic simulation datasets
├── notebooks:      Sample tutorial notebooks
├── starfysh:       Starfysh core model

How to cite Starfysh

Please cite Starfysh paper published in Nature Biotechnology:

He, S., Jin, Y., Nazaret, A. et al.
Starfysh integrates spatial transcriptomic and histologic data to reveal heterogeneous tumor–immune hubs.
Nat Biotechnol (2024).
https://doi.org/10.1038/s41587-024-02173-8

BibTex

@article{He2024,
  title = {Starfysh integrates spatial transcriptomic and histologic data to reveal heterogeneous tumor–immune hubs},
  ISSN = {1546-1696},
  url = {http://dx.doi.org/10.1038/s41587-024-02173-8},
  DOI = {10.1038/s41587-024-02173-8},
  journal = {Nature Biotechnology},
  publisher = {Springer Science and Business Media LLC},
  author = {He,  Siyu and Jin,  Yinuo and Nazaret,  Achille and Shi,  Lingting and Chen,  Xueer and Rampersaud,  Sham and Dhillon,  Bahawar S. and Valdez,  Izabella and Friend,  Lauren E. and Fan,  Joy Linyue and Park,  Cameron Y. and Mintz,  Rachel L. and Lao,  Yeh-Hsing and Carrera,  David and Fang,  Kaylee W. and Mehdi,  Kaleem and Rohde,  Madeline and McFaline-Figueroa,  José L. and Blei,  David and Leong,  Kam W. and Rudensky,  Alexander Y. and Plitas,  George and Azizi,  Elham},
  year = {2024},
  month = mar 
}

If you have questions, please contact the authors: