Skip to content

The complete FlowSOM package known from R, now available in Python

License

Notifications You must be signed in to change notification settings

TarikExner/FlowSOM_Python

 
 

Repository files navigation

FlowSOM

Documentation

The complete FlowSOM package known from R, now available in Python

Getting started

Please refer to the documentation. In particular, the

Installation

You need to have Python 3.9 or newer installed on your system. If you don't have Python installed, we recommend installing Mambaforge.

There are several alternative options to install FlowSOM:

  1. Install the latest development version:
pip install git+https://github.com/saeyslab/FlowSOM_Python

Usage

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:

# Import the FlowSOM package
import flowsom as fs

# Load the FCS file
ff = fs.io.read_FCS("./tests/data/ff.fcs")

# Run the FlowSOM algorithm
fsom = fs.FlowSOM(
    ff, cols_to_use=[8, 11, 13, 14, 15, 16, 17], xdim=10, ydim=10, n_clus=10
)

# Plot the FlowSOM results
p = fs.pl.plot_stars(fsom, background_values=fsom.get_cluster_data().obs.metaclustering)
p.show()

Release notes

See the changelog.

Contact

For questions and help requests or if you found a bug, please use the issue tracker.

Citation

If you use FlowSOM in your work, please cite the following paper:

Sofie Van Gassen, Britt Callebaut, Mary J. Van Helden, Bart N. Lambrecht, Piet Demeester, Tom Dhaene and Yvan Saeys. FlowSOM: Using self-organizing maps for visualization and interpretation of cytometry data. Cytometry A 2015, volume 87.7 (p. 636-645)

DOI: 10.1002/cyto.a.22625

About

The complete FlowSOM package known from R, now available in Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%