- Open Access
Canary: an atomic pipeline for clinical amplicon assays
BMC Bioinformatics volume 18, Article number: 555 (2017)
High throughput sequencing requires bioinformatics pipelines to process large volumes of data into meaningful variants that can be translated into a clinical report. These pipelines often suffer from a number of shortcomings: they lack robustness and have many components written in multiple languages, each with a variety of resource requirements. Pipeline components must be linked together with a workflow system to achieve the processing of FASTQ files through to a VCF file of variants. Crafting these pipelines requires considerable bioinformatics and IT skills beyond the reach of many clinical laboratories.
Here we present Canary, a single program that can be run on a laptop, which takes FASTQ files from amplicon assays through to an annotated VCF file ready for clinical analysis. Canary can be installed and run with a single command using Docker containerization or run as a single JAR file on a wide range of platforms. Although it is a single utility, Canary performs all the functions present in more complex and unwieldy pipelines. All variants identified by Canary are 3′ shifted and represented in their most parsimonious form to provide a consistent nomenclature, irrespective of sequencing variation. Further, proximate in-phase variants are represented as a single HGVS ‘delins’ variant. This allows for correct nomenclature and consequences to be ascribed to complex multi-nucleotide polymorphisms (MNPs), which are otherwise difficult to represent and interpret. Variants can also be annotated with hundreds of attributes sourced from MyVariant.info to give up to date details on pathogenicity, population statistics and in-silico predictors.
Canary has been used at the Peter MacCallum Cancer Centre in Melbourne for the last 2 years for the processing of clinical sequencing data. By encapsulating clinical features in a single, easily installed executable, Canary makes sequencing more accessible to all pathology laboratories.
Canary is available for download as source or a Docker image at https://github.com/PapenfussLab/Canary under a GPL-3.0 License.
Clinical diagnostics is being transformed by technology capable of analysing patient DNA at the nucleotide level. The accuracy, turnaround time and reproducibility of clinical sequencing rely heavily on bioinformatics pipelines that convert raw sequencing data into meaningful variants. These pipelines are characterised by multiple software dependencies, lack of portability, complex parameter tuning and often need a cluster computing environment for parallel execution . These attributes result in pipelines that are hard to deploy in a production clinical environment.
Here we introduce Canary, a stand-alone Java utility that performs the function of multi-tool pipelines and can generate annotated VCF files directly from zipped FASTQ files generated from amplicon assays. As Canary only requires a Java runtime, it can be deployed on any computer with Java installed, in contrast to the myriad dependencies of most current pipelines. Additionally, it is available as a Docker  image from their public repository allowing it to be installed and run on any platform supporting Docker with a single command:
% docker run -v /tmp/data:/canary.data dockercanary/canary
The processing of amplicon sequence data using ubiquitous shotgun sequencing pipelines leads to suboptimal results in terms of speed and quality [3, 4]. There are relatively few options for processing amplicon data outside of commercial platforms such as Illumina BaseSpace . This platform only caters for proprietary Illumina assays such as Amplicon TruSeq and TruSight and does not allow for custom panels that target other genes or permit incorporating amplicon analysis into an in-house pipeline. Non-commercial amplicon software include: Mutascope  which doesn’t perform alignment, AmpliVar  which doesn’t perform variant calling and UNDR ROVER  which doesn’t normalise, 3’ shift or annotate the variants produced. Canary simplifies the pipeline steps required with a single command to go from zipped FASTQ files to an annotated VCF file suitable for clinical curation. It is assumed that the FASTQ files have been quality controlled previously by a program such as FASTQC .
To our knowledge, Canary is the only tool that can perform all the necessary pipeline steps of alignment, variant calling, normalisation, transcript selection and rich annotation in a single executable program.
Targeted amplicon sequencing is a cost effective way for deeply sequencing a panel of genes of interest . Its depth and ability to target specific gene regions, such as oncogene hot spots, makes it effective and efficient for cancer diagnostic assays. The design of amplicon assays calls for paired primers at specific genomic positions. As the position of these primers is known, this allows bypassing the computationally expensive alignment step of typical pipelines. Canary exploits this fact, along with read caching, to achieve rapid processing of FASTQ files and speeding up of overall sample turnaround time. If amplicon forward and reverse primers are separated by a distance slightly greater than sequencer read length, paired short reads will overlap the amplicon region of interest. Canary uses this overlap to combine paired reads and reduce random read errors. The combined read is then aligned to the reference amplicons to identify variants. Read combining and alignment is performed using a fast C++ Smith-Waterman library  (see Fig. 1). The targeted nature of amplicon assays reduces the volume of reads to process but allows for exact alignments without compromising speed. Additional speed is gained by implementing a read cache which hashes the combined, aligned reads along with any variant calls.
The advantage of amplicon panels is the targeted capture of specific regions of interest at very high coverage (>1000×) but with the disadvantage of a PCR step, which may amplify errors in poorly covered regions. This step masks copy number variation in the sample. To reduce false positive PCR artefacts, somatic samples can be sequenced as technical replicates and laboratories can report only variants appearing in both replicates. For all NA12878 control samples in 2017 sequencing runs (n = 133), the median percent of variants per sample that appeared in only one replicate was 38.8%. This represents a considerable workload saving but with the additional cost of reagents and wet lab processing.
In paired end sequencing, base quality decreases across the length of the reads and the second read is often of less quality than the first. These effects can be mitigated with amplicon sequencing by producing a consensus read from an overlapping amplicon read pair. The overall error rates are therefore discontinuous across the amplicon with lower rates in the overlapping region. Tiling multiple amplicons across regions of interest is an effective strategy for achieving high quality sequencing in critical areas of the genome.
To call variants, merged reads are aligned against the reference amplicons also using the Smith-Waterman algorithm. All variants found are cached in a hash map keyed by the raw read pair to speed up processing for recurring reads. Any variants occurring within 15 bp of each other (configurable) are also counted as compound in-phase variants as they occur within a merged read pair that is sequenced from a single strand of DNA. Variants further apart, but within the same merged pair are treated as independent events and counted as different variants. Although Canary reports MNPs, the individual component variants are also reported individually allowing the discretion of downstream reporting of either the MNPs or their constituent variants. For example, the variant BRAF:c.1798_1799delinsAG p.V600R would also be reported as BRAF:c.1798G > A p.V600 M and BRAF:c.1799 T > G p.V600G. It is noteworthy that the latter two variants individually predict different amino acids (Methionine and Glycine) while the ‘delins’ variant predicts Arginine highlighting the need for reporting MNPs to correctly identify molecular consequences.
After all reads have been processed, variant counts are summed and if they exceed the minimum read count and variant allele frequency (VAF) thresholds, they are passed to the normalisation phase.
The use of the Smith-Waterman alignment of merged reads against the amplicon reference sequence allows for large indels to be accurately called without a computationally expensive indel realignment step. The maximum size deletion called for all sequence results, in 2016, was 191 bp (median = 1 bp, n = 190,552 variants) and the maximum insertion was 78 bp (median = 1 bp, n = 73,107 variants).
In clinical variant reporting, it is routine to use the Human Genome Variation Society (HGVS) nomenclature , with explicitly named Refseq transcripts . Pipelines and variant callers produce VCF files of variants described with [chromosome, position, reference base, alternate base] tuples. This representation is unsuitable for clinical use as multiple tuples can map to a single genomic change. Due to the difficulty of representing larger indels and MNPs, many laboratories may report and submit variants to curation databases in a non-canonicalised or incorrect notation.
Canary is able to correctly render variants, together with a Refseq transcript, as HGVSg, HGVSc and HGVSp in their most parsimonious 3′ shifted form . Complex in-phase multi-nucleotide variants are correctly rendered as ‘delins’ variants saving error-prone manual interpretation - a common cause of clinical variant description error. By performing these complex operations, Canary allows downstream curation and reporting systems to consistently and correctly report clinical variants. Variants are normalised in Canary by multiple queries to the Mutalyzer  web site API, which can be locally installed on a virtual machine for convenience. VCF variants are converted to HGVSg format and batch submitted and converted to one or more (Refseq transcript, HGVSc, HGVSp) tuples. For variants with multiple transcripts, the preferred tuple is chosen from a gene to transcript list, which maps a gene to the single most ‘common’ transcript for a gene. An editable gene to transcript mapping file is provided with Canary. This list has been manually curated by the Peter MacCallum Cancer Centre but other laboratories may prefer different transcripts for reporting. It has been shown that the choice of transcript can significantly impact variant annotation .
If multiple preferred transcripts are found for a variant, the transcript with the variant closest to an exon is chosen. This transcript is then batch validated with the Mutalyzer API. Variants are 3′ shifted with respect to the chosen transcript and, if needed, any ‘ins’ variants are changed to their ‘dup’ equivalent if necessary. Any variants that are 3′ shifted are then resubmitted back to the API to shift their chromosome position as well. The final genomic position will match the cDNA position for both positive and negative strand transcripts. Although not strictly matching the rules for HGVSg variants (where variants are right shifted with respect to the chromosome) this approach is felt to be less confusing.
The above process ensures a unique representation for each variant and allows for consistent matching between sequencing runs, patients and databases. See Fig. 2.
Accessing and maintaining comprehensive and timely annotation data sources is an onerous task for any laboratory but this is critical in a clinical setting. Common tools for annotating VCF files and other genomic information include; Annovar [15, 16], SnpEff  and Variant Effect Predictor (VEP) . These tools have, until recently, required the downloading of large datafiles or caches to operate and places the burden of large data storage and maintenance on the users. The increasing emergence of API driven annotation improves the timeliness of data and reduces the overhead of accessing the latest genomic annotations. Canary harnesses this trend by using online sites for both genomic transcript nomenclature (Mutalyzer.nl ) and variant annotation (MyVariant.info ). Using online data sources avoids the need to download very large databases of gene, transcript and variant information, which must be managed and refreshed periodically to maintain currency. These two online sources are maintained by groups that specialise in keeping the data current while also aggregating reference data sources from NCBI, Clinvar, dbNSFP, CADD and many others.
If supplied with a list of MyVariant data fields, Canary will retrieve these annotations for each variant and add these to INFO field of the generated VCF file. These annotations are retrieved in real-time from MyVariant as the file is created and cover most of the useful annotation sources available . Fields are described in a hierarchical “dotted” notation, which indicates the underlying data source, for example, the gene protein domain from Cadd  data is specified as cadd.gene.prot.domain. A list of desired annotations can be passed as a file to Canary, which will add this data to the VCF file. Note that not every variant will have every annotation attribute as some data will not be relevant or available for every variant.
A typical command line usage is shown below together with explanations of options. More detailed descriptions and additional command line options may be found in Additional file 1. The code provides additional entry points if the functions need to be embedded within a larger system.
Canary can be also used as a utility within a larger pipeline to just annotate a VCF file by enriching its ‘INFO’ fields with correct HGVS nomenclature and optionally generating a tab separated variant file suitable for directly loading into a spreadsheet or uploading to a database.
To assess the performance of Canary in both germline and somatic contexts, three experiments were performed with well-studied samples containing known variants.
To evaluate performance with germline samples, DNA from the Coriell cell line DNA NA12878 (Coriell Cell Repository, Camden, NJ) was sequenced in 54 runs over a period of eight months during 2017 as a control sample on a custom myeloid amplicon panel on Illumina MiSeq instruments. Two NA12878 samples were sequenced as technical replicates on each run giving a total of 108 samples sequenced. Nine NA12878 high confidence variants were found to intersect the amplicon capture region by using bedtools v2.26  and the NIST Genome in a Bottle NA12878 vcf/bed file repository . The sequencer generated FASTQ files were used by Canary to create annotated VCF files calling variants with greater than 20% variant allele frequency. Of the total true positives (TP) expected, 972 = 54 * 2 * 9, Canary found 970. The FASTQ files for the missing two variants were inspected. One contained reduced coverage for the amplicon at the locus where the true positive should have been but contained the variant at a VAF = 1.95% which was below the Canary VAF threshold setting. The other FASTQ file contained sufficient reads but no true positive variant. It did however, contain a novel variant (for the control) suggesting wet lab contamination. If we exclude these two samples as likely wet lab issues, Canary recovered 100% of the control variants. An additional 1124 false positive (FP) variants were called giving a precision (TP/(TP + FP)) of 46.3% and a sensitivity (TP/(TP + FN)) of 100%. Of these false positives, 84.9% were variants occurring in more than 35% of samples (including patient samples and NA12878 control samples) analysed by the assay during this period. Because of their high frequency in the assay results, they are inferred to be technical artefacts due to amplicon primer specific artefacts. For routine clinical assays, these recurrently occurring assay variants are flagged by the pipeline and excluded from further analysis.
To compare Canary to other pipelines, three pipelines were run on ten NA12878 samples sequenced in ten runs during June and July 2017. The three pipelines used were; 1) Canary performing both read alignment and variant calling down to a variant allele frequency of 20%, 2) BWA-MEM 2 (0.7.20) performing read alignment and GATK haplotype caller for variant calling and 3) BWA-MEM 2 performing read alignment and VarDict for variant calling. The summary results, including raw calls, TP, FP, FN, sensitivity and precision, are shown in Additional file 2: Table S1. All pipelines recovered all nine true positive variants except for one variant not found by VarDict. Canary was shown to have the best precision with Canary 42.8%, GATK 21.9%, VarDict 17.1%, Sensitivity: Canary 100%, GATK 100%, VarDict 98.9%). For detailed results see Additional file 2: Table S1 in the supplementary files.
To evaluate somatic performance, samples from the Acrometrix Oncology Hotspot Frequency Ladder were used (Thermofisher, Australia) . The ladder samples consist of a synthetic “chromosome” mixed with genomic DNA from the Personal Genome Project cell line GM24385 . The synthetic variants were confirmed by Sanger sequencing and the frequencies in each of six dilutions were quantified by digital droplet PCR. The frequencies provided were 48%, 29%, 18%, 11%, 5%, and 3%. The samples were run on an Illumina MiSeq sequencer and the reads converted to paired-end FASTQ files. These files were then run against the three pipelines described above except that the Canary pipeline called variants down to a variant allele frequency of 1%. The pipelines were run on the Acrometrix samples to generate VCF files and determine true positives (TP) n = 46, false positives (FP) and false negatives (FN). Variant read depth was also used to compare against the expected allele frequencies of the 46 expected variants. See Fig. 3 and Additional file 2: Table S1. Instances of the pipeline commands and their parameters can be found in Additional file 3: File 3. All pipelines performed acceptably in recapitulating the VAF of the samples with Canary performing best (Mean VAF differences; Canary 2.3%, GATK 3.6%, VarDict 4.2%). Canary showed the best sensitivity and fully recovered all expected variants at all allele frequencies except for five variants in Sample A with the lowest expected VAF of 2.8%. In contrast, the GATK and VarDict pipelines performed increasingly poorly at low allele frequencies and showed both lower average sensitivity and lower average precision than Canary. (Sensitivity: Canary 98.2%, GATK 58.7%, VarDict 66.3%, Precision: Canary 7.5%, GATK 1.0%, VarDict 0.9%). These results would not be representative of normal practice, as pipeline parameters will usually be tuned for their corresponding assay. It would also be more common to use GATK MuTect for a tumour/normal somatic assay but normal samples were not available for these samples. We also note that VarDict also supports an amplicon mode and a tumour-normal mode in addition to its default single sample non-amplicon mode. When run on the Acrometrix samples in amplicon mode, VarDict performed more poorly (fewer true positive variants) than in its default mode.
Canary was also faster than the other pipelines over three repeated runs of Sample F with the following mean wall clock run times, Canary 14.0 min., GATK 16.3 min. and VarDict 32.0 min. These runs were performed on a heterogeneous cluster with comparable loads for all runs. Both the GATK and VarDict pipelines used multithreading to achieve faster throughput but Canary currently only supports single thread execution. Execution is currently proportional to the number of amplicons times the number of reads and would lend itself to parallel execution in subsequent releases. The GATK and VarDict times do not include annotation times for these pipelines whereas annotation is built into the Canary processing allowing its output to be readily incorporated into downstream workflows. Canary was also run three times on Sample F on a Mac laptop with 16Gb of memory with a mean elapsed runtime of 14.0 min, matching cluster runtimes.
Typical performance of Canary is between 7 and 10 min when processing a full Illumina MiSeq run of 48 samples (22 patient samples in replicate and 4 controls), performing alignment, variant calling and annotation, on a computing cluster. These times are for an in-house myeloid assay of 216 amplicons covering key exons of 26 genes with a total panel size of 29.9 kilobases. The average read pairs per sample were 375,522 and the average cache hit ratio was 20.5%.
Canary has been used with custom and commercial amplicon diagnostic panels as part of PathOS, a complete clinical diagnostic system . It is integrated into clinical pipelines within the Molecular Pathology Department of the Peter MacCallum Cancer Centre for over a year while the Normalisation module has been used for the last two years.
Since its introduction into the diagnostic pipeline in November 2015, Canary has processed 8,203 patient samples and identified 199,693 variants of which 5,055 were clinically reportable in 1,880 patients. The reported variants included 498 deletions, 78 insertions and 76 MNPs. The MNPs comprised variants with a combined deletions of between 1 and 28 bp and insertions of between 1 and 11 bp.
Canary has also been integrated into a Minimum Residual Disease (MRD) pipeline used to detect recurrent indels due to disease relapse in haematological malignancies post therapy (manuscript accepted for publication). This pipeline employs ultra-deep (500,000×) sequencing to detect a single read or more containing the recurrence of an indel originally detected in the patient sample prior to therapy. Indels used for MRD are sufficiently unlikely to occur as the result of random error.
In conclusion, Canary fills the need for a readily deployable amplicon pipeline utility capable of rendering complex variants with consistent and correct nomenclature suitable for clinical reporting. Available as a Docker image, it is easily integrated into laboratories needing to perform the necessary pipeline steps of alignment, variant calling, normalisation, transcript selection and rich annotation within a single executable program.
Project Name: Canary.
Project Home Page: https://github.com/PapenfussLab/Canary
Operating System(s): Docker  compatible OS (e.g. Linux, Mac, AWS, Azure, Windows).
Programming Languages: Groovy , Java.
Other requirements: Reference data.
License: GNU license - GPL 3.0 .
Application Programming Interface
Binary Alignment Map format
Combined Annotation Dependent Depletion
A variant which combines a deletion and an insertion
Human Genome Variant Society
Insertion / Deletion
Minimum Residual Disease
National Association of Testing Authorities
Next Generation Sequencing
Next Generation Sequencing
Polymerase Chain Reaction
Tab separated variable format
Variant Allele Frequency
Variant Call Format
Doig K, Papenfuss AT, Fox S. Clinical cancer genomic analysis: data engineering required. The Lancet Oncology. 2015;16:1015–7. doi:10.1016/S1470-2045(15)00195-3.
Docker. Docker containerisation site, http:/http://www.docker.com. Accessed 29 Nov 2017.
Park DJ, et al. UNDR ROVER - a fast and accurate variant caller for targeted DNA sequencing. BMC bioinformatics. 2016;17:165. doi:10.1186/s12859-016-1014-9. Accessed 29 Nov 2017.
Yost SE, et al. Mutascope: sensitive detection of somatic mutations from deep amplicon sequencing. Bioinformatics. 2013;29:1908–9. doi:10.1093/bioinformatics/btt305.
Hsu AL, et al. AmpliVar: mutation detection in high-throughput sequence from amplicon-based libraries. Hum Mutat. 2015;36:411–8. doi:10.1002/humu.22763.
Wong SQ, et al. Assessing the clinical value of targeted massively parallel sequencing in a longitudinal, prospective population-based study of cancer patients. Br J Cancer. 2015;112:1411–20. doi:10.1038/bjc.2015.80.
Zhao M, Lee WP, Garrison EP, Marth GT. SSW library: an SIMD smith-waterman C/C++ library for use in genomic applications. PLoS One. 2013;8:e82138. doi:10.1371/journal.pone.0082138.
HGVS. HGVS Nomenclature, http://varnomen.hgvs.org. Accessed 29 Nov 2017.
Rehm HL, et al. ACMG clinical laboratory standards for next-generation sequencing. Genetics in medicine : official journal of the American College of Medical Genetics. 2013;15:733–47. doi:10.1038/gim.2013.92.
Tan A, Abecasis GR, Kang HM. Unified representation of genetic variants. Bioinformatics. 2015;31:2202–4. doi:10.1093/bioinformatics/btv112.
McCarthy DJ, et al. Choice of transcripts and software has a large effect on variant annotation. Genome medicine. 2014;6:26. doi:10.1186/gm543.
Wang K, Li M, Hakonarson H. ANNOVAR: functional annotation of genetic variants from high-throughput sequencing data. Nucleic Acids Res. 2010;38:e164. doi:10.1093/nar/gkq603.
Yang H, Wang K. Genomic variant annotation and prioritization with ANNOVAR and wANNOVAR. Nat Protoc. 2015;10:1556–66. doi:10.1038/nprot.2015.105.
Cingolani P, et al. A program for annotating and predicting the effects of single nucleotide polymorphisms, SnpEff. Fly. 2012;6:80–92. doi:10.4161/fly.19695.
McLaren W, et al. Deriving the consequences of genomic variants with the Ensembl API and SNP effect predictor. Bioinformatics. 2010;26:2069–70. doi:10.1093/bioinformatics/btq330.
MyVariant. http://myvariant.info. Accessed 29 Nov 2017.
Xin J, et al. High-performance web services for querying gene and variant annotation. Genome Biol. 2016;17:91. doi:10.1186/s13059-016-0953-9.
Kircher M, et al. A general framework for estimating the relative pathogenicity of human genetic variants. Nat Genet. 2014;46:310–5. doi:10.1038/ng.2892.
Quinlan AR, Hall IM. BEDTools: a flexible suite of utilities for comparing genomic features. Bioinformatics. 2010;26:841–2. doi:10.1093/bioinformatics/btq033.
NA12878. Genome in a bottle consortium, http://www.genomeinabottle.org. Accessed 29 Nov 2017.
Acrometrix, Thermofisher, https://www.thermofisher.com/au/en/home/brands/product-brand/acrometrix.html. Accessed 29 Nov 2017
Coriell Institute, GM24385, https://catalog.coriell.org/0/Sections/Search/Sample_Detail.aspx?Ref=GM24385&Product=CC. Accessed 29 Nov 2017.
Doig KD, et al. PathOS: a decision support system for reporting high throughput sequencing of cancers in clinical diagnostic laboratories. Genome medicine. 2017;9:38. doi:10.1186/s13073-017-0427-z.
Groovy. The Groovy Language, http://www.groovy-lang.org. Accessed 29 Nov 2017.
GNU General Public License https://www.gnu.org/licenses/ - GPL. Accessed 29 Nov 2017.
The authors would like to acknowledge the generosity of our funders in making this project possible. Thanks to Christopher Love for assisting with SRA archiving.
Availability of data and material
A Docker  image and the source code for Canary is available under the GNU license - GPL 3.0 , from the GitHub repository at (https://github.com/PapenfussLab/Canary), please contact the corresponding author for more detail. The application has been built in Groovy  (a Java byte compatible JVM language) and publically available Java libraries. Validation FASTQ files have been uploaded to Sequence Read Archive (SRA) submission: SUB3175435.
This research was supported by the Laby Foundation, The Peter Mac Foundation, Therapeutics Innovation Australia and a National Health and Medical Research Council (NHMRC) Program Grant (1054618). The research benefitted by support from the Victorian State Government Operational Infrastructure Support and Australian Government NHMRC Independent Research Institute Infrastructure Support.
Ethics approval and consent to participate
Consent for publication
The authors declare that they have no competing interests.
Springer Nature remains neutral with regard to jurisdictional claims in published maps and institutional affiliations.
canary usage.docx: Description of the Canary command line options. (DOCX 136 kb)
xlsx: Comparison statistics for Canary, BWA, GATK and VarDict. (XLSX 45 kb)
Example Pipeline Commands.txt: Validation pipeline command examples. (TXT 6 kb)
About this article
Cite this article
Doig, K.D., Ellul, J., Fellowes, A. et al. Canary: an atomic pipeline for clinical amplicon assays. BMC Bioinformatics 18, 555 (2017). https://doi.org/10.1186/s12859-017-1950-z
- Targeted sequencing
- Clinical diagnostics
- Variant calling