Skip to main content

One liner tool to check the quality of your single-cell atlases.

Project description

CheckAtlas

PyPI PyPI - Downloads PyPI - License install with bioconda

codecov CI Documentation Status Gitter

Static Badge Static Badge Static Badge

CheckAtlas is a one liner tool to check the quality of your single-cell atlases. For every atlas, it produces the quality control tables and figures which can be then processed by multiqc. CheckAtlas is able to check the quality of Scanpy, Seurat, and CellRanger files.

More information on the read the doc page

Summary

Powered by nextflow, checkatlas can be ran in one command line:

nextflow run nf-core-checkatlas -r dev --path search_folder/

The checkatlas workflow start with a fast crawl through your working directory. It detects Seurat (.rds), Scanpy (.h5ad) or cellranger (.h5) atlas files.

Then, it goes through all atlas files and produce summary information:

  • All basic QC (nRNA, nFeature, ratio_mito)
  • General information (nbcells, nbgenes, nblayers)
  • All elements in atlas files (obs, obsm, uns, var, varm)
  • Reductions (pca, umap, tsne)
  • All metrics (clustering, annotation, dimreduction, specificity)

All tables and figs are saved in the checkatlas_files folder in your search folder.

A single html report is produced, using MultiQC, in checkatlas_files/Checkatlas-MultiQC.html.

Checkatlas workflow

Examples

  • Evaluate and compare different scanpy atlases: Example 1

  • Evaluate different version of one atlas: Example 2

  • Evaluate Scanpy, Seurat and CellRanger objects in your folder: Example 3

  • Evaluate an integrated Scanpy atlas with the corresponding raw CellRanger atlases: Example 4

  • Evaluate different Cellranger atlases with multiple chemistry version and cellranger version: Example 5

Installation

CheckAtlas is in two parts. The checkatlas pythn module which can be downloaded with PyPi, and the checkatlas workflow which can be downloaded with nextflow.

pip install checkatlas
nextflow pull becavin-lab/nf-core-checkatlas

You need also to install a version of MultiQC with checkatlas capability (for the moment). This version of MultiQC is available at checkatlas branch of github.com:becavin-lab/MultiQC.

git clone git@github.com:becavin-lab/MultiQC.git
cd MultiQC/
git checkout checkatlas
pip install .

Finally, checkatlas comes with rpy2 to perform the interface between python and R. But, it does not automatically install Seurat. So if you want to screen Seurat atlases you need to perfrom this last installation

% R
> install.packages('Seurat')
> library(Seurat)

Development

This project is in a very early development phase. All helpers are welcome. Please contact us or submit an issue.

Read the CONTRIBUTING.md file.

Checkatlas has two repositories:

It has a module on MultiQC

The checkatlas package is available on PyPI

The bioconda recipe has been submitted

Project developed thanks to the project template : (https://github.com/rochacbruno/python-project-template/)

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

checkatlas-0.4.15.tar.gz (31.7 kB view hashes)

Uploaded Source

Built Distribution

checkatlas-0.4.15-py3-none-any.whl (42.8 kB view hashes)

Uploaded Python 3

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