Skip to main content

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

Vireo is available through PyPI. To install, type the following command line, and add -U for upgrading:

pip install vireoSNP

Alternatively, you can download or clone this repository and type python setup.py install to install. In either case, add --user if you don’t have the permission as a root or for your Python environment.

For more instructions, see the installation manual.

Quick Usage

The following two subsections are quick usage guide. For more 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.

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

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

Mode 1: without any genotype:

vireo -c $CELL_DATA -N $n_donor -o $OUT_DIR

Mode 2: with genotype for all samples (specify tag -t: GT, GP, or PL)

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

Mode 3: with genotype for part of the samples (N is different from the sample number in $DONOR_GT_FILE)

vireo -c $CELL_DATA -d $DONOR_GT_FILE -o $OUT_DIR -N $n_donor

Mode 4: with genotype but not confident

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

In modes 3 and 4, the algorithm will run mode 1 first to estimate the genotypes of N donors and match them to the given donor genotypes (even partial). For the matched samples and SNPs, the input genotypes will replace the estiamted values as a prior in the second run.

Note, the cell data ($CELL_DATA) via -c can be any of the following two formats:

  • standard VCF file (compressed or uncompressed) with variants by cells

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

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.

Metadata

Release files for vireoSNP 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vireoSNP 0.1.3
File Size Uploaded
vireoSNP-0.1.3.tar.gz 15.4 kB Details

Release files / vireoSNP-0.1.3.tar.gz

Download URL vireoSNP-0.1.3.tar.gz
Size 15.4 kB
Tags Source
SHA-256 checksum
How to use checksums
df5a084a33c8495a210f2df8343a0f715ad5a6a73a23299414a90bdbc94d15cd
BLAKE2b-256 checksum
How to use checksums
2c0fbaf3e73f6aa909e1ba8f9838c85445d62d599ec44e28ac06b39501b6cb47
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

0.5.9

1 release file

0.5.8

1 release file

0.5.7

1 release file

0.5.6

1 release file

0.5.5

1 release file

0.5.0

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.3.2

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

This release

0.1.3 This release

1 release file

0.1.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page