Skip to main content

Hierarchical progressive learning pipeline for single-cell RNA-sequencing datasets

Project description

|PyPI| |PyPIDownloads| |Docs|

scHPL: Hierarchical progressive learning of cell identities in single-cell data

.. raw:: html

We present a hierarchical progressive learning method which automatically finds relationships between cell populations across multiple datasets and uses this to construct a hierarchical classification tree. For each node in the tree either a linear SVM, kNN, or one-class SVM, which enables the detection of unknown populations, is trained. The trained classification tree can be used to predict the labels of a new unlabeled dataset.

NOTE: scHPL is not a batch correction tool, we advise to align the datasets before matching the cell populations. We advise doing this with scVI or scArches (see section treeArches below).

Installation

scHPL requires Python 3.6 or higher. The easiest way to install scHPL is through the following command::

pip install scHPL

General usage

The tutorial.ipynb notebook explains the basics of scHPL. The vignette folder </vignettes>_ contains notebooks to reproduce the inter-dataset experiments. See the documentation <https://schpl.readthedocs.io/en/latest/>_ for more information.

treeArches

treeArches is a framework around scHPL and scArches <https://github.com/theislab/scarches>_ to automatically build and update reference atlases and the classification tree. Examples can be found in the treeArches reprodicibility Github <https://github.com/lcmmichielsen/treeArches-reproducibility>_ and in this notebook <https://github.com/theislab/scarches/blob/master/notebooks/treeArches_pbmc.ipynb>_.

Datasets

All datasets used are publicly available data and can be downloaded from Zenodo. The simulated data and aligned datasets used during the interdataset experiments can be downloaded from the scHPL Zenodo <https://doi.org/10.5281/zenodo.4557712>. The filtered PBMC-FACS and AMB2018 dataset can be downloaded from the scRNA-seq benchmark Zenodo <https://doi.org/10.5281/zenodo.3357167>

For citation and further information please refer to: "Hierarchical progressive learning of cell identities in single-cell data" <https://www.nature.com/articles/s41467-021-23196-8>_

.. |PyPI| image:: https://img.shields.io/pypi/v/scHPL.svg :target: https://pypi.org/project/scHPL

.. |PyPIDownloads| image:: https://static.pepy.tech/badge/scHPL :target: https://pepy.tech/project/scHPL

.. |Docs| image:: https://readthedocs.org/projects/schpl/badge/?version=latest :target: https://schpl.readthedocs.io

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scHPL-1.0.5.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

scHPL-1.0.5-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file scHPL-1.0.5.tar.gz.

File metadata

  • Download URL: scHPL-1.0.5.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.13

File hashes

Hashes for scHPL-1.0.5.tar.gz
Algorithm Hash digest
SHA256 3eb62b2e65b1faba04b7bcb86f7bf6967a6301866a605551211b8f14fd27eced
MD5 3e318e5b023874fd4e32a7780c3479ef
BLAKE2b-256 fa1c42f29f32fe0d0e8620025dfd5e12900abde310696e56250132cc2e17be23

See more details on using hashes here.

File details

Details for the file scHPL-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: scHPL-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.13

File hashes

Hashes for scHPL-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1d1ba8464b1853d1d72bc0ad278e51a670a028adb3d71264da2e186045bce225
MD5 4b8af22b94d8d5b7846919fe0e943ede
BLAKE2b-256 dcc0ffa98fba041fa01e7863d424422b20cceade8ef9eec68c7058848cdb0ecd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page