Detect interesting SARS-CoV-2 spike protein variants from Sanger sequencing data.
Project description
Detect interesting SARS-CoV-2 spike protein mutations from Sanger sequencing data
covid-spike-classification
is a script to call interesting SARS-CoV-2 spike protein mutations
from Sanger sequencing to support the Danish COVID-19 monitoring efforts.
Using Sanger-sequenced RT-PCR product of the spike protein, this tool should pick up all relevant
mutations currently tracked (see covid_spike_classification/core.py
for the full list of tracked mutations) and give a table with one row per sample and a
yes/no/failed column per tracked mutation.
This workflow is built and maintained at https://github.com/kblin/covid-spike-classification
Installation
covid-spike-classification
is distributed via this git repository, pypi or bioconda.
Bioconda
Installing via bioconda is the fastest way to get up and running:
conda create -n csc -c conda-forge -c bioconda covid-spike-classification
conda activate csc
git & pypi
When installing via git or pypi, you first need to install the external binary dependencies.
covid-spike-classification
depends on three excellent tools to do most of the work:
- tracy (versions 0.5.3 & 0.5.7 tested)
- bowtie2 (version 2.4.2 tested)
- samtools (versions 1.10 & 1.11 tested)
If you have conda
installed, the easiest way to get started is to just install these via calling
git clone https://github.com/kblin/covid-spike-classification.git
cd covid-spike-classification
conda env create -n csc -f environment.yml
conda activate csc
pip install .
Docker, Podman, Singularity
While not technically an installation method, covid-spike-classification
is also shipped as an OCI container.
To use it, you ideally run the container from a workflow management system like Snakemake
or Nextflow that will take care of mounting filesystems into the container for you.
The OCI container image is available from the Docker Hub kblin/covid-spike-classification
repository.
Setup
You also need to generate the samtools and bowtie2 indices for your reference genome. We ship a copy of NC_045512 and a script to generate these indices:
conda activate csc
cd ref
./build_indices.sh
cd ..
Usage
Assuming you used above instructions to install via conda, you can run the tool like this:
conda activate csc
covid-spike-classification --reference /path/to/your/reference.fasta --outdir /path/to/result/dir /path/to/sanger/reads/dir_or.zip
Notably, you can provide the input either as a ZIP file or as a directory, as long as they directly contain the ab1 files you want to run the analysis on.
See also the --help
output for more detailed usage information.
License
All code is available under the Apache License version 2, see the
LICENSE
file for details.
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 covid-spike-classification-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1cfcf270c7ca153eb84713028bc2f9759a88d8457ababee996d10fb7467649a6 |
|
MD5 | 3e598036add0484f43ef23c99e7a69e9 |
|
BLAKE2b-256 | abc0788c61923fdf6a91c63abf2dc026113999bd9fa2c1345377c5dd2d27c2c6 |
Hashes for covid_spike_classification-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d5dee73b968c6914cb3156a082ce59831705ac8a7b3279761c66dbe994b9618 |
|
MD5 | 71c55bb5fbb0ca48c1a8bff899115921 |
|
BLAKE2b-256 | 45ea8bd23115713502e9baa58baf60670e5d61cac004c7e9d1dea3ebafe3aacb |