Skip to main content

amplicon/smMIP mapping and analysis pipeline

Project description

https://raw.githubusercontent.com/koelling/amplimap/master/amplimap_logo_400px.png https://circleci.com/gh/koelling/amplimap.svg?style=svg Documentation Status

amplimap: amplicon mapping and analysis pipeline

amplimap is a command-line tool to automate the processing and analysis of data from targeted next-generation sequencing (NGS) experiments with PCR-based amplicons or capture-based enrichment systems.

From raw sequencing reads, amplimap generates a variety of output files including read alignments, per-basepair nucleotide counts, target coverage data and annotated variant calls.

In addition to its focus on user-friendliness and reproducibility, amplimap supports advanced features such as the generation of consensus base calls for read families based on molecular identifiers/barcodes (UMIs) and the detection of chimeric reads caused by amplification of off-target loci.

Installation

We recommend that you install amplimap through Conda:

wget https://raw.githubusercontent.com/koelling/amplimap/master/environment.yml
conda env create --file environment.yml

We also have a Docker image available. Please see our full installation instructions for additional details.

Overview

To run amplimap you create a directory containing a small set of input files:

  • A subdirectory with FASTQ.GZ or BAM files representing your different samples (tested with Illumina MiSeq, HiSeq and NextSeq)

  • Optionally: Files describing the targeted genomic regions, the primers you used or other custom configuration parameters

Then you can run amplimap to generate a variety of different output files, depending on your experiment. These include, for example:

  1. A target coverage table, showing you how well-covered each target region was in each sample.

  2. A table of germline variants in your samples, annotated with gene, impact, population frequencies, deleteriousness scores, etc.

  3. A per-basepair “pileup” table telling you how often each nucleotide was seen in each sample at each position.

Built on top of Snakemake and Python 3, amplimap is entirely automated and can be run on a single machine as well as on an HPC cluster (e.g. LSF, SGE).

Supported experimental protocols

amplimap is compatible with most targeted sequencing protocols that generate paired-end short read data.

For protocols utilising PCR or smMIPs each read should start with a known primer (or targeting arm) sequence, followed by the amplified target DNA. Reads can optionally contain a unique molecular identifier (UMI) sequence in front of the primer, which can be used to group reads into families. Data should be available as demultiplexed FASTQ.GZ files, with each pair of files representing a different sample.

For capture-based protocols data can be provided in FASTQ.GZ or unmapped/mapped BAM format, which may contain UMIs as BAM tags.

Some of the protocols we have analyzed with amplimap include:

Tutorials

Citation and License

Licensed under the Apache License, version 2.0. Copyright 2020 Nils Koelling. When you use amplimap, please cite the amplimap paper in your work:

Nils Koelling, Marie Bernkopf, Eduardo Calpena, Geoffrey J Maher, Kerry A Miller, Hannah K Ralph, Anne Goriely, Andrew O M Wilkie, amplimap: a versatile tool to process and analyze targeted NGS data, Bioinformatics, Volume 35, Issue 24, 15 December 2019, Pages 5349–5350, https://doi.org/10.1093/bioinformatics/btz582

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

amplimap-0.4.20.tar.gz (130.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page