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
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 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.
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
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)
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/)
FAQs
One liner tool to check the quality of your single-cell atlases.
We found that checkatlas demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.