Skip to content

Commit 6094b04

Browse files
author
Andrew Ramirez
committed
Update README and documentation
1 parent 5243dcb commit 6094b04

File tree

3 files changed

+7
-13
lines changed

3 files changed

+7
-13
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ RISE (Reduction and Insight in Single-cell Exploration) is an unsupervised, tens
44

55
RISE does not require prior cell-type labels or clustering, reducing bias and enabling discovery of novel cell states, while also separating technical, biological, and condition-driven variation without batch correction that may erase meaningful signals. Its high resolution enables the identification of cell populations and condition-specific subpopulations missed by pseudobulk or clustering-based approaches, and each resulting component is directly linked to specific conditions, genes, and cells, making the results biologically tractable.
66

7-
- **Discuss development** on [GitHub](https://github.com/meyer-lab/RISE).
87
- **Read the documentation** at [RISE Documentation](https://meyer-lab.github.io/RISE/).
9-
- **Install** via `pip install git+https://github.com/meyer-lab/RISE.git@main`.
108
- RISE uses the [AnnData](https://anndata.readthedocs.io/) format for handling single-cell data matrices.
119

1210
## Installation

docs/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Overview
88

99
RISE (Reduction and Insight in Single-cell Exploration) is an unsupervised, tensor-based computational method designed for the integrative analysis of single-cell RNA sequencing (scRNA-seq) data across multiple experimental conditions, such as drug treatments, patient cohorts, or time points. Built upon the PARAFAC2 tensor decomposition framework,
1010
RISE preserves the inherent three-dimensional structure of multi-condition single-cell data—conditions x cells x genes—instead of flattening it into a conventional two-dimensional matrix. This allows RISE to decompose variation into distinct, interpretable patterns associated with experimental conditions, individual cells, and genes, providing a
11-
more nuanced and biologically meaningful analysis. RISE does not require prior cell-type labels or clustering, reducing bias and enabling discovery of novel cell states, while also separating technical, biological, and condition-driven variation without batch correction that may erase meaningful signals.
11+
more nuanced and biologically meaningful analysis.
12+
13+
RISE does not require prior cell-type labels or clustering, reducing bias and enabling discovery of novel cell states, while also separating technical, biological, and condition-driven variation without batch correction that may erase meaningful signals.
1214
Its high resolution enables the identification of cell populations and condition-specific subpopulations missed by pseudobulk or clustering-based approaches, and each resulting component is directly linked to specific conditions, genes, and cells, making the results biologically tractable.
1315

1416
.. toctree::

docs/references.rst

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,10 @@ RISE Paper
88

99
Integrative, high-resolution analysis of single-cell gene expression across experimental conditions with PARAFAC2-RISE. *Cell Systems*, 2025. DOI: `10.1016/j.cels.2025.101294 <https://doi.org/10.1016/j.cels.2025.101294>`_
1010

11-
Factor Match Score (FMS)
12-
------------------------
11+
PARAFAC2 and Factor Match Score
12+
--------------------------------
1313

14-
Factor Match Score is used to assess the stability and reproducibility of tensor decomposition results. For more information on FMS, see:
14+
RISE is built upon the PARAFAC2 tensor decomposition framework, which allows factor matrices in one mode to change across slices while maintaining a constant cross-product constraint. Factor Match Score (FMS) is used to assess the stability and reproducibility of tensor decomposition results across different runs.
1515

16-
Tomasi, G., & Bro, R. (2006). A comparison of algorithms for fitting the PARAFAC model. *Computational Statistics & Data Analysis*, 50(7), 1700-1734. DOI: `10.1016/j.csda.2004.11.013 <https://doi.org/10.1016/j.csda.2004.11.013>`_
16+
Roald, M., Schenker, C., Calhoun, V.D., Adali, T., Bro, R., Cohen, J.E., & Acar, E. (2022). An AO-ADMM approach to constraining PARAFAC2 on all modes. *SIAM Journal on Mathematics of Data Science*, 4(3), 1191-1222. DOI: `10.1137/21M1450033 <https://doi.org/10.1137/21M1450033>`_
1717

18-
AnnData Format
19-
--------------
20-
21-
RISE uses the AnnData format for storing and manipulating single-cell data:
22-
23-
Virshup, I., Rybakov, S., Theis, F.J., Angerer, P., & Wolf, F.A. (2021). anndata: Annotated data. *bioRxiv*. DOI: `10.1101/2021.12.16.473007 <https://doi.org/10.1101/2021.12.16.473007>`_

0 commit comments

Comments
 (0)