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 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 .
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.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4215e902944ba9029a0c46ede4b655e38ef7a256720bd0e9c0e07243c9d166a8 |
|
MD5 | a3cf74b43597764439f5753f677a49c7 |
|
BLAKE2b-256 | df04c835a909e1108c4df40ac71cab6f1a19ceab85e0c2b4f799db8efdbaa9fc |
Hashes for covid_spike_classification-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33b3d0e937d8d69ec5f8d212356b78139b2bd3e09326597b0541ea7f83fad42d |
|
MD5 | fa226a8c04863cfad694c7d99cc22a2c |
|
BLAKE2b-256 | 916107c380fff752588365d441e60ed19b1c07e15c10ae94650c20ba56728eee |