Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 2.44 KB

README.md

File metadata and controls

86 lines (66 loc) · 2.44 KB

Build Status License: GPL v3 Don't judge me

⚠️ This software is still in early development

amplikate

Generic typing tool from amplicons and/or in silico PCR

Introduction

There are numerous genotyping systems for microbes, but they all have something in common: they identify small pieces of genome sequence that are useful in some way, and use combinations of these sequences to assign a "type", usually a single number. The classic example of this being MLST.

Traditionally in the wet lab these sequences would be determined by using PCR primers followed by Sanger capillary sequencing. In the new world of WGS, we have sequence reads (FASTQ) or assembled contigs (FASTA). With contigs, we can either use in silico PCR, or identify the amplicon directly, with BLAST for example.

Once we have identified all relevant amplicons, the amplicon (allele) combinations are converted into a genotype using a "profile table" like this:

TYPE AMP_1 AMP_2 AMP_3
1    1     1     1
2    2     1     1
3    3     1     2
...
324 23   178    76

Quick Start

% amplikate --version
amplikate 0.1.2

Installation

Conda

Install Conda or Miniconda:

conda install -c conda-forge -c bioconda -c defaults amplikate # COMING SOON

Homebrew

Install HomeBrew (Mac OS X) or LinuxBrew (Linux).

brew install brewsci/bio/amplikate # COMING SOON

Source

This will install the latest version direct from Github. You'll need to add the amplikate bin directory to your $PATH, and also ensure all the dependencies are installed.

cd $HOME
git clone https://github.com/tseemann/amplikate.git
$HOME/amplikate/bin/amplikate --help

Dependencies

  • perl >= 5.26

License

amplikate is free software, released under the GPL 3.0.

Issues

Please submit suggestions and bug reports to the Issue Tracker

Author

Torsten Seemann