Skip to main content

Automated scRNA-seq filtering

Project description

![alt text](data/dropkick_logo.png)

### Automated cell filtering for single-cell RNA sequencing data.

[![Latest Version][pypi-image]][pypi-url]

dropkick works primarily with [Scanpy](https://icb-scanpy.readthedocs-hosted.com/en/stable/)’s AnnData objects, and accepts input files in .h5ad or flat (.csv, .tsv) format. It also writes outputs to .h5ad files when called from the terminal.

Installation via pip or from source requires a Fortran compiler (brew install gcc for Mac users).

#### Install from PyPI: `bash pip install dropkick `

#### Or compile from source: `bash git clone https://github.com/KenLauLab/dropkick.git cd dropkick python setup.py install `

dropkick can be run as a command line tool or interactively with the [scanpy](https://icb-scanpy.readthedocs-hosted.com/en/stable/) single-cell analysis suite.

#### Usage from command line: `bash dropkick path/to/counts.h5ad `

Output will be saved in a new .h5ad file containing __dropkick__ scores, labels, and model parameters.

You can also run the dropkick.qc module from terminal for a quick look at the total UMI distribution and ambient genes, saved as *_qc.png: `bash dropkick path/to/counts.h5ad --qc `

See [dropkick_tutorial.ipynb](dropkick_tutorial.ipynb) for an interactive walkthrough of the dropkick pipeline and its outputs.

[pypi-image]: https://img.shields.io/pypi/v/dropkick [pypi-url]: https://pypi.python.org/pypi/dropkick/

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

dropkick-1.1.0.tar.gz (21.7 MB view hashes)

Uploaded Source

Built Distribution

dropkick-1.1.0-cp37-cp37m-macosx_10_14_x86_64.whl (412.4 kB view hashes)

Uploaded CPython 3.7m macOS 10.14+ x86-64

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