Skip to content

Commit c07062d

Browse files
add readme
1 parent 40a5661 commit c07062d

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,25 @@
77
[link-tests]: https://github.com/florianingelfinger/CytoVI/actions/workflows/test.yml
88
[badge-docs]: https://img.shields.io/readthedocs/CytoVI
99

10-
Variational inference for cytometry
10+
Variational inference for antibody-based single cell technologies.
1111

12-
## Getting started
12+
CytoVI accomplishes the following analysis tasks:
13+
14+
- Integration/batch correction
15+
- Differential protein expression analysis
16+
- Label-free differential abundance analysis
17+
- Imputation of unseen proteins from overlapping antibody panels
18+
- Technology integration (e.g. Flow and Mass cytometry)
19+
- RNA/modality imputation after integration of flow/mass cytometry data with CITE-seq data
20+
- Automated cell annotation via transfer learning
1321

14-
Please refer to the [documentation][link-docs]. In particular, the
22+
## Getting started
1523

16-
- [API documentation][link-api].
24+
To get started please check out the basic analysis notebook in the [docs](https://github.com/florianingelfinger/CytoVI/blob/main/docs/notebooks/Basic_CytoVI_workflow.ipynb).
1725

1826
## Installation
1927

20-
You need to have Python 3.9 or newer installed on your system. If you don't have
28+
You need to have Python 3.10 or newer installed on your system. If you don't have
2129
Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
2230

2331
There are several alternative options to install CytoVI:

0 commit comments

Comments
 (0)