diff --git a/analyses/README.md b/analyses/README.md index 60d27fead..ee64bedb7 100644 --- a/analyses/README.md +++ b/analyses/README.md @@ -2,3 +2,13 @@ This directory contains the [OpenScPCA analysis modules](https://openscpca.readt Each directory represents a single analysis module. Each module contains a `README.md` file with information on its scientific goals and how to run it. + +## Example modules + +Several modules are provided as examples for how to use certain frameworks in OpenScPCA: + +| Module name | Purpose +|-------------|--------- +| [`hello-R`](hello-R/) | Demonstrates an example structure of an R-based module +| [`hello-python`](hello-python/) | Demonstrates an example structure of a Python-based module +| [`hello-clusters`](hello-clusters/) | Provides notebooks demonstrating the use of clustering and cluster evaluations functions in the [`rOpenScPCA` package](https://github.com/AlexsLemonade/rOpenScPCA/)