demuxalot 0.4.3
Scalable and reliable demulitplexing for single-cell RNA sequencing.
License: MIT
Requires Python: >=3.8
Keywords: bayesian modelling, demultiplexing, genotype learning, single cell RNA sequencing

<p align="center">
<img width="500" alt="demuxalot_logo_small" src="https://user-images.githubusercontent.com/6318811/118947887-a261da00-b90c-11eb-8932-a66e6d2caa1f.png">
</p>
 
[![Run tests and deploy](https://github.com/arogozhnikov/demuxalot/actions/workflows/run_test.yml/badge.svg)](https://github.com/arogozhnikov/demuxalot/actions/workflows/run_test.yml)
<img src="./.github/python_badge.svg">
# Demuxalot 

Reliable and efficient identification of genotypes for individual cells in RNA sequencing.
Demuxalot refines its knowledge about genotypes directly from the data.

Demuxalot is fast and optimized to work with lots of genotypes, 
enabling efficient reutilization of inferred information from the data.

Preprint [is available at biorxiv.](https://www.biorxiv.org/content/10.1101/2021.05.22.443646v2)

## Background

During single-cell RNA-sequencing (scRnaSeq) we pool cells from different donors and process them together.

- Pro: all cells come through the same pipeline, so preparation/biological variation effects are cancelled out from analysis automatically. 
  Also experiments are much cheaper!
- Con: we don't know cell origin, everything is mixed!

Demuxalot solves the con: 
it guesses genotype of each cell by matching reads coming from cell against genotypes. 
This is called *demultiplexing*.

## Comparisons

Demuxalot shows high reliability, data efficiency and speed. 
Below is a benchmark on PMBC data with 32 donors from [preprint](https://www.biorxiv.org/content/10.1101/2021.05.22.443646v2)

<img width="1434" alt="Screen Shot 2021-06-03 at 6 03 12 PM" src="https://user-images.githubusercontent.com/6318811/120730293-07cdd300-c496-11eb-8a9c-62c8b8cf9847.png">

> [!NOTE]
> we used `demuxalot` internally for a number of challenging scenarios with a large biobank and low-depth sequencing,
> and it shines in these scenarios too. Actually, that's why algorithm was created in the first place.


## Known genotypes and refined genotypes: the tale of two scenarios

Typical approach to get genotype-specific mutations are 
 
- whole-genome sequencing (expensive, very good)
  - you have information about all (ok, >90%) the genotype, and it is unlikely that you need to refine it
  - so you just go straight to demultiplexing
  - demuxlet solves this case
- Bead arrays (aka SNP arrays aka DNA microarrays) are super cheap and practically more relevant
  - you get information about ~650k most common SNPs, and that's only a small fraction, but you also pay very little
  - this case is covered by `demuxalot` (this package)
  - [Illumina's video](https://www.youtube.com/watch?v=lVG04dAAyvY) about this technology

## Why is it worth refining genotypes? 
   
SNP array provides up to ~650k positions in the genome.
Around 20-30% of them would be specific for a genotype (i.e. deviate from majority).

Each genotype has around 10 times more SNV (single nucleotide variations) that are not captured by array. 
Some of these missing SNPs are very valuable for demultiplexing.

## What's special power of demuxalot?

- much better handling of multiple reads coming from the same UMI (i.e. same transcript)
  - `demuxalot` efficiently combines information from multiple reads with same UMI and cross-checks it
- default settings are CellRanger-specific (that is - optimized for 10X pipeline). Cellranger's and STAR's flags in BAM break some common conventions, 
  but we can still efficiently use them (by using filtering callbacks)  
- ability to refine genotypes. without failing and diverging
  - Vireo is a tool that was created with similar purposes. But it either diverges or does not learn better genotypes
- optimized variant calling. It's also faster than `demuxlet` due to multiprocessing
- this is not a command-line tool, and not meant to be 
  - write python code, this gives full control and flexibility of demultiplexing

## Installation

Plain and simple:
```bash
pip install demuxalot # Requires python >= 3.8
```

Here are some common scenarios and how they are implemented in demuxalot.
Also visit `examples/` folder

## Running (simple scenario)
Only using provided genotypes

```python
from demuxalot import Demultiplexer, BarcodeHandler, ProbabilisticGenotypes, count_snps

# Loading genotypes
genotypes = ProbabilisticGenotypes(genotype_names=['Donor1', 'Donor2', 'Donor3'])
genotypes.add_vcf('path/to/genotypes.vcf')

# Loading barcodes
barcode_handler = BarcodeHandler.from_file('path/to/barcodes.csv')

snps = count_snps(
    bamfile_location='path/to/sorted_alignments.bam',
    chromosome2positions=genotypes.get_chromosome2positions(),
    barcode_handler=barcode_handler, 
)

# returns two dataframes with likelihoods and posterior probabilities 
likelihoods, posterior_probabilities = Demultiplexer.predict_posteriors(
    snps,
    genotypes=genotypes,
    barcode_handler=barcode_handler,
)
```


## Running (complex scenario)

Refinement of known genotypes is shown in a notebook, see `examples/`


## Saving/loading genotypes
   
```python
# You can always export learnt genotypes to be used later
refined_genotypes.save_betas('learnt_genotypes.parquet')
refined_genotypes = ProbabilisticGenotypes(genotype_names= <list which genotypes to load here>)
refined_genotypes.add_prior_betas('learnt_genotypes.parquet')
```


## Re-saving VCF genotypes with betas (recommended)

Loading of internal parquet-based format is *much* faster than parsing/validating VCF.
Makes sense to export VCF to internal format in two cases:

1. when you plan to load it many times.
2. when you want to 'accumulate' inferred information about genotypes from multiple scnraseq runs
 

```python
genotypes = ProbabilisticGenotypes(genotype_names=['Donor1', 'Donor2', 'Donor3'])
genotypes.add_vcf('path/to/genotypes.vcf')
genotypes.save_betas('learnt_genotypes.parquet')

# later you can use it. 
genotypes = ProbabilisticGenotypes(genotype_names=['Donor1', 'Donor2', 'Donor3'])
genotypes.add_prior_betas('learnt_genotypes.parquet')
```