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:
A target coverage table, showing you how well-covered each target region was in each sample.
A table of germline variants in your samples, annotated with gene, impact, population frequencies, deleteriousness scores, etc.
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:
PCR-based targeted resequencing (single/multiplex)
Probe based target enrichment, for example:
Tutorials
Links
Package: https://pypi.org/project/amplimap/
Documentation: https://amplimap.readthedocs.io/
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
Metadata
Release files for amplimap 0.4.20
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| amplimap-0.4.20.tar.gz | 130.5 kB | Without provenance | Details for amplimap-0.4.20.tar.gz |
Release files / amplimap-0.4.20.tar.gz
| Download URL | amplimap-0.4.20.tar.gz |
|---|---|
| Size | 130.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
34f8e4f26554cde8200cec52b28b01ed27e9991734a73921880360f58efe5b7f
|
|
BLAKE2b-256 checksum How to use checksums |
87c4b916be536d41aaeed917d14b8ce875f66954905670c9f2ecdab6d872bb07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.6.12
|
Security for amplimap 0.4.20
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.