Skip to content

Commit 3c23cb9

Browse files
committed
update readme
1 parent 722177a commit 3c23cb9

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

README.md

+28-11
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
# FlowSOM
22

3-
[![Tests][badge-tests]][link-tests]
3+
[![PyPI version][badge-pypi]][link-pypi]
4+
[![Conda version][badge-conda]][link-conda]
45
[![Documentation][badge-docs]][link-docs]
6+
[![Tests][badge-tests]][link-tests]
7+
[![codecov][badge-codecov]][link-codecov]
8+
[![DOI][badge-doi]][link-doi]
59

610
[badge-tests]: https://img.shields.io/github/actions/workflow/status/saeyslab/FlowSOM_Python/test.yaml?branch=main
711
[link-tests]: https://github.com/saeyslab/FlowSOM_Python/actions/workflows/test.yaml
812
[badge-docs]: https://img.shields.io/readthedocs/flowsom
13+
[link-docs]: https://flowsom.readthedocs.io/en/latest/
14+
[badge-pypi]: https://img.shields.io/pypi/v/flowsom
15+
[link-pypi]: https://pypi.org/project/flowsom/
16+
[badge-conda]: https://img.shields.io/conda/vn/conda-forge/flowsom
17+
[link-conda]: https://anaconda.org/conda-forge/flowsom
18+
[badge-doi]: https://img.shields.io/badge/DOI-10.1093%2Fbioinformatics%2Fbtae179-blue
19+
[link-doi]: https://doi.org/10.1093/bioinformatics/btae179
20+
[badge-codecov]: https://codecov.io/gh/saeyslab/FlowSOM_Python/branch/main/graph/badge.svg
21+
[link-codecov]: https://codecov.io/gh/saeyslab/FlowSOM_Python
922

10-
The complete FlowSOM package known from R, now available in Python!
23+
The complete FlowSOM package known from R and [Bioconductor](https://www.bioconductor.org/packages/release/bioc/html/FlowSOM.html), now available in Python with [scverse](https://scverse.org/) integration!
24+
25+
FlowSOM is a clustering and visualization algorithm originally based on a self-organizing map (SOM). FlowSOM is used to distinguish cell populations from cytometry data in an unsupervised way and
26+
can help to gain deeper insights in fields such as immunology and oncology.
1127

1228
## Getting started
1329

@@ -19,25 +35,26 @@ Please refer to the [documentation][link-docs]. In particular, the following res
1935

2036
## Installation
2137

22-
You need to have Python 3.9 or newer installed on your system. If you don't have
23-
Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
24-
25-
There are several alternative options to install FlowSOM:
38+
You need to have Python 3.9 or newer installed on your system. There are several options to install FlowSOM:
2639

27-
<!--
28-
1) Install the latest release of `FlowSOM` from `PyPI <https://pypi.org/project/FlowSOM/>`_:
40+
**Recommended installation**: install the latest release of FlowSOM from [PyPI](https://pypi.org/project/FlowSOM/):
2941

3042
```bash
31-
pip install FlowSOM
43+
pip install flowsom
3244
```
33-
-->
3445

35-
1. Install the latest development version:
46+
Alternative 1: install the development version from the GitHub repository:
3647

3748
```bash
3849
pip install git+https://github.com/saeyslab/FlowSOM_Python
3950
```
4051

52+
Alternative 2: install the [FlowSOM Conda package](https://anaconda.org/conda-forge/flowsom) via the Conda package manager:
53+
54+
```bash
55+
conda install -c conda-forge flowsom
56+
```
57+
4158
## Usage
4259

4360
Starting from an FCS file that is properly transformed, compensated and checked for quality, the following code can be used to run the FlowSOM algorithm:

0 commit comments

Comments
 (0)