Skip to main content

vireoSNP - donor deconvolution for multiplexed scRNA-seq data

Project description

PyPI Docs Build Status

vireo: donor deconvolution for pooled single-cell data

Vireo: Variational Inference for Reconstructing Ensemble Origin by expressed SNPs in multiplexed scRNA-seq data.

The name vireo follows the theme from cardelino (for clone deconvolution), while the Python package name is vireoSNP to aviod name confilict on PyPI.

Installation

The easiest way is to install via PyPI by typing this line is terminal:

pip install vireoSNP

Alternatively, you can always download this repository and install manually:

python setup.py install

For more options of installation, see the full installation.

Usage and manual

Genotyping for each cell (pre-step)

There might be some bioinformatics efforts in this step, however, a few existing software can provide a solution. There are often two steps for this:

  1. identify candidate SNPs: known common SNPs / freebayes / cellSNP

  2. genotype candidate SNPs in each cell: cellSNP / vartrix / bcftools mpileup

See more introduction in the genotyping section.

Demultiplexing from allelic expression

This python package offers a set of utilities functions and an executable command line vireo for donor deconvolution in any of these four situations

  1. without any genotype:

    vireo -c $CELL_DATA -N $n_donor -o $OUT_DIR
  2. with genotype for all samples (tag via -t: GT, GP, or PL)

    vireo -c $CELL_DATA -d $DONOR_GT_FILE -o $OUT_DIR
  3. with genotype for part of the samples

    vireo -c $CELL_DATA -d $DONOR_GT_FILE -o $OUT_DIR -N $n_donor
  4. with genotype but not confident

    vireo -c $CELL_DATA -d $DONOR_GT_FILE -o $OUT_DIR --forceLearnGT

The cell data can be any of the following two formats:

  • standard VCF file with variants by cells

  • a cellSNP output folder containing VCF for variants info and sparse matrices AD and DP

For details, see the full manual or type “vireo -h” for all arguments. We also provide a demo.sh for running the test data sets in this repo.

Reference

Yuanhua Huang, Davis J. McCarthy, and Oliver Stegle. Vireo: Bayesian demultiplexing of pooled single-cell RNA-seq data without genotype reference. bioRxiv (2019): 598748.

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

vireoSNP-0.1.2.tar.gz (14.5 kB view details)

Uploaded Source

File details

Details for the file vireoSNP-0.1.2.tar.gz.

File metadata

  • Download URL: vireoSNP-0.1.2.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.8

File hashes

Hashes for vireoSNP-0.1.2.tar.gz
Algorithm Hash digest
SHA256 df5a926e0361bd1f6acb455baf2780cde8cf311a5f3860a30de319432823d287
MD5 375b03f7b44495a312c9c0bbfa547266
BLAKE2b-256 8d5cb8ec7a9ab68c83302a745579c8fe9305cdf27b40e8939c0317178a1264e7

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