Metadata-Version: 2.4
Name: firefate
Version: 0.0.1
Summary: FIREFate: Functional and Interpretable Regulatory Encoding of cell Fate decisions
Author: Akanksha Sachan
License: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.23
Requires-Dist: pandas>=1.5
Requires-Dist: scipy>=1.10
Requires-Dist: matplotlib>=3.7
Requires-Dist: plotly>=5.18
Requires-Dist: tqdm>=4.65
Requires-Dist: joblib>=1.3
Requires-Dist: networkx>=3.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Provides-Extra: celloracle
Requires-Dist: celloracle; extra == "celloracle"
Provides-Extra: scanpy
Requires-Dist: scanpy; extra == "scanpy"
Provides-Extra: docs
Requires-Dist: sphinx<9,>=7; extra == "docs"
Requires-Dist: furo>=2024.8.6; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
Requires-Dist: sphinx-design>=0.6.0; extra == "docs"
Requires-Dist: sphinx-autobuild>=2024.0.0; extra == "docs"
Dynamic: license-file

# FIREFate (Functional and Interpretable Regulatory Encoding of cellular Fate)

This repository provides an open-source toolkit, which delivers multi-scale insights at the cell-population, gene-regulatory and epigenomic levels to predict fate-bias during cell state transitions, and infer regulatory components governing cell fate decisions. The framework is built for single-cell (sc-snRNA/scATAC-seq) datasets for both matched or un-matched multi-omic sequenced populations.

![Interpretable modules](fig_1_bio.png)

Downstream tasks include - 

1. Discovery of interpretable cellular programs (CPs) underlying phenotypically-contrasting cell states, arising from natural progression of cellular processes or fate-biasing interventions.

2. Prediction of fate-biased cell populations in uncommitted states during differentiation, using CPs inferred from intervention datasets (TF-KO)

3. Construction of State-Specific GRNs, and a combined cross-state GRN whose connectivity spans both states in (1), for enrichment of Transcription Factor (TF) activity, which regulates the CP encoding the discriminative phenotype between states.

4. Construction of Transition-Window-Specific GRNs, with clustered regulatory edges to temporally order waves of TF regulation.

5. Construction of Episodic GRNs that capture TF–target forces held temporally invariant across each episode, for enrichment of dynamic TF epigenomic and regulatory activity within each CP, underlying cell fate.

6. Quantification of in-silico perturbation effects from state-specific (DONE) /dynamic phenotypic shifts (TO-DO) induced by perturbing enriched TFs.

## Documentation

User guide and API reference are built with Sphinx and hosted on **Read the Docs** (configure the
project at [readthedocs.org](https://readthedocs.org/) to point at this repository; the config file
is `.readthedocs.yaml`). After publishing, the site is typically available at
[https://firefate.readthedocs.io/](https://firefate.readthedocs.io/) when the project slug is
`firefate`.

To build the HTML docs locally:

```bash
pip install ".[docs]"
sphinx-build -W -b html docs docs/_build/html
```
