One liner tool to check the quality of your single-cell atlases
Project description
CheckAtlas
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 load Scanpy, Seurat, and CellRanger files.
Summary
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 load Scanpy, Seurat, and CellRanger files.
Summary
-
Parse Scanpy, Seurat and CellRanger objects
CheckAtlas should be able to load : .rds, .h5 and .h5ad corresponding to single-cell experiment. Need to implement :
- Fast crawl through your folder and detect Seurat, Scanpy or cellranger atlas files.
- Automatic search in atlas files for key information = raw data, normalized data, integrated data, reductions, layers, assays, metadatas, etc...
-
Create checkatlas summary files
Go 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)
-
Parse checkatlas files in MultiQC
Update MultiQC project to add checkatlas parsing. Dev project in: https://github.com/becavin-lab/MultiQC/tree/checkatlas
https://checkatlas.readthedocs.io/en/latest/
Examples
- Evaluate and compare different atlases: https://github.com/becavin-lab/checkatlas/blob/3a4f88e94716c09a3b9c86010f570743a5855461/examples/Atlas_comparison.ipynb
https://checkatlas.readthedocs.io/en/stable/CheckAtlas_example_1/CheckAtlas_example_1.html
- Evaluate different version of your atlas: https://github.com/becavin-lab/checkatlas/blob/3a4f88e94716c09a3b9c86010f570743a5855461/examples/Version_comparison.ipynb
https://checkatlas.readthedocs.io/en/stable/CheckAtlas_example_2/CheckAtlas_example_2.html
- Explore Scanpy, Seurat and CellRanger objects in your folder: https://github.com/becavin-lab/checkatlas/blob/main/examples/AtlasType_comparison.ipynb
https://checkatlas.readthedocs.io/en/stable/CheckAtlas_example_3/CheckAtlas_example_3.html
Installation
CheckAtlas can be downloaded from PyPI. However, the project is in an early development phase. We strongly recommend to use the developmental version.
Install checkatlas development version
git clone git@github.com:becavin-lab/checkatlas.git
pip install checkatlas/.
Install MultiQC with checkatlas file management. 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 .
Install it from PyPI
pip install checkatlas
Install Seurat
To be able to manage seurat file, rpy2 should have Seurat installed. The easiest way is to put all checkatlas requirements in a conda environment and add r-seurat.
conda create -n checkatlas python=3.9
pip install checkatlas
conda install -c bioconda r-seurat
Or, open R in checkatlas environment (the one where you ran 'pip install') and install Seurat.
% R
> install.packages('Seurat')
> library(Seurat)
Usage
The one liner way to run checkatlas is the following:
$ cd your_search_folder/
$ python -m checkatlas .
#or
$ checkatlas .
Or run it inside your python workflow.
from checkatlas import checkatlas
checkatlas.run(path, atlas_list, multithread, n_cpus)
Development
Read the CONTRIBUTING.md file.
Project developed thanks to the project template : (https://github.com/rochacbruno/python-project-template/)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for checkatlas-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1ea6ab3d5b82c9a6f872823a46f935e7b1ec337c8a20b6f25336d4ef4903726 |
|
MD5 | 68dda824a2460e33896ad64a6137c5f6 |
|
BLAKE2b-256 | 165413f2f290b3967c262a0170be920bb829f87326d606ce347c5322afc62866 |