Skip to content

Optimal gating strategies for flow and mass cytometry.

License

Notifications You must be signed in to change notification settings

buettnerlab/convexgating

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

overview

PyPI Python Version License Read the documentation at https://convexgating.readthedocs.io/ Build Package Status Run Tests Status Codecov pre-commit Black

Features

Convex gating is a Python package to infer an optimal gating strategy from flow, cyTOF or Ab/CITE-seq data. Convex gating expects a labelled input (for instance, from clustering) and returns a gating panel to separate the selected group of events (e.g. a cluster) from all other events (see Fig. 1a). For each cluster, it reports the purity (precision), yield (recall) and the harmonic mean of both metrics (F1 score) for each gate hierarchy and the entire gating strategy. It relies on the scanpy/anndata for the data format and data pre-processing and further on PyTorch for stochastic gradient descent. Therefore, resulting gates may slightly vary.

overview

The iterative procedure to find a suitable gate before applying the convex hull is illustrated in the following graphic.

Update

Installation

git clone https://github.com/buettnerlab/convexgating.git
cd convexgating
pip install -e .

Usage

A usage example is available in the docs/tutorials/tutorial_01.ipynb file located in this repository

Please see the Command-line Reference for details.

Credits

This package was created with cookietemple using Cookiecutter based on Hypermodern_Python_Cookiecutter.