nf-core/abotyper
A pipeline for characterising the Human Blood Group and Red Cell Antigens using Oxford Nanopore third-generation sequencing data.
Introduction
This document describes the output produced by the pipeline. Most of the plots are taken from the MultiQC report, which summarises results at the end of the pipeline.
The directories listed below will be created in the results directory after the pipeline has finished. All paths are relative to the top-level results directory.
For each sample, the pipeline aligns reads once against a single combined ABO reference (spanning exons 2β7) and generates BAM files, BAM metrics, and per-position variant statistics.
The output directory generated by this Nextflow pipeline will look something like this:
OUTDIR/βββ ABO_results.logβββ ABO_result.txtβββ ABO_result.xlsxβββ final_export.csvβββ per_sample_processingβ βββ SAMPLE1_barcode01β βββ combinedβ βββ ABOReadPolymorphisms.txtβ βββ alignmentβ β βββ SAMPLE1_barcode01.bamβ β βββ SAMPLE1_barcode01.bam.baiβ β βββ SAMPLE1_barcode01.coverage.txtβ β βββ SAMPLE1_barcode01.flagstatβ β βββ SAMPLE1_barcode01.statsβ βββ SAMPLE1_barcode01.ABOPhenotype.txtβ βββ SAMPLE1_barcode01.AlignmentStatistics.tsvβ βββ SAMPLE1_barcode01.Haplotypes.tsvβ βββ SAMPLE1_barcode01.log.txtβββ pipeline_infoβΒ Β βββ execution_report_DATETIME.htmlβΒ Β βββ execution_timeline_DATETIME.htmlβΒ Β βββ execution_trace_DATETIME.txtβΒ Β βββ nf_core_pipeline_software_mqc_versions.ymlβΒ Β βββ params_DATETIME.jsonβΒ Β βββ pipeline_dag_DATETIME.htmlβββ qc-reports βββ fastqc βΒ Β βββ SAMPLE1_barcode01_fastqc.html βΒ Β βββ SAMPLE1_barcode01_fastqc.zip βββ multiqc βββ multiqc_data βββ multiqc_plots βΒ Β βββ pdf βΒ Β βββ png βΒ Β βββ svg βββ multiqc_report.htmlThe ABO_result.xlsx Excel worksheet contains details of all SNVs and metrics used to deduce the ABO phenotype for each sample.
A summary of the ABO typing results is provided in final_export.csv
Feel free to raise an issue or reach out if you need any support getting this tool running, or with suggestions for improvement.
Pipeline overview
The pipeline is built using Nextflow and processes data using the following steps:
- FastQC β Raw read quality control
- Minimap2 β Mapping reads to the combined ABO reference
- SAMtools Coverage β Coverage metrics
- SAMtools Flagstat β Alignment summary statistics
- SAMtools Stats β Detailed alignment metrics
- HAPLOSCAN β Per-position nucleotide frequency and per-read haplotype extraction
- ABO SNP Interpretation β Custom logic to infer ABO phenotype
- MultiQC β Aggregate report describing results and QC from the whole pipeline
FastQC
Output files
fastqc/*_fastqc.html: FastQC report containing quality metrics.*_fastqc.zip: Zip archive containing the FastQC report, tab-delimited data file and plot images.
FastQC provides general quality metrics about your sequenced reads, including base quality scores, GC content, adapter contamination, and overrepresented sequences.
Minimap2
Output files
alignment/*.bam: Aligned reads in BAM format.*.bai: BAM index files.
Minimap2 is used to align Nanopore reads to the single combined ABO reference FASTA. It supports long-read data and is optimized for speed and accuracy.
SAMtools Modules
This set of modules use SAMtools and its subtools to extract key metrics and data from aligned BAM files. These outputs are used for quality control and coverage analysis.
Output subtool files
coverage/*.coverage.txt: Coverage metrics per sample.
flagstat/*.flagstat.txt: Summary of alignment flags.
stats/*.stats.txt: Detailed alignment statistics.
Coverage: Calculates per-base and overall coverage statistics to assess sequencing depth and uniformity.
Flagstat: Provides a quick summary of alignment quality, including total reads, mapped reads, duplicates, and other key metrics.
Stats: Generates comprehensive metrics such as insert size distributions, read lengths, and mapping quality.
Nucleotide Quantification
Output files
combined/*.AlignmentStatistics.tsv: Per-position nucleotide frequency and coverage table.*.Haplotypes.tsv: Per-read haplotype table, enabling cis-phasing across every diagnostic position on the same read.ABOReadPolymorphisms.txt: Summary of polymorphic positions observed.
pysam_haploscan.py (the HAPLOSCAN module) computes per-position nucleotide frequencies and per-read haplotypes directly from the aligned BAM in a single pass, replacing a separate samtools mpileup step.
ABO SNP Interpretation
Output files
phenotype/*.snp_summary.txt: Summary of ABO-related SNPs.*.phenotype.txt: Predicted ABO phenotype per sample.
This custom module interprets SNP data to infer ABO blood group phenotypes using curated reference profiles and decision rules.
MultiQC
Output files
multiqc/multiqc_report.html: A standalone HTML file that can be viewed in your web browser.multiqc_data/: Directory containing parsed statistics from the different tools used in the pipeline.multiqc_plots/: Directory containing static images from the report in various formats.
MultiQC aggregates results from FastQC, SAMtools, and other modules into a single interactive report. It also includes software version tracking for reproducibility.
Pipeline information
Output files
pipeline_info/- Reports generated by Nextflow:
execution_report.html,execution_timeline.html,execution_trace.txtandpipeline_dag.dot/pipeline_dag.svg. - Reports generated by the pipeline:
pipeline_report.html,pipeline_report.txtandsoftware_versions.yml. Thepipeline_report*files will only be present if the--email/--email_on_failparameterβs are used when running the pipeline. - Reformatted samplesheet files used as input to the pipeline:
samplesheet.valid.csv. - Parameters used by the pipeline run:
params.json.
- Reports generated by Nextflow:
Nextflow provides excellent functionality for generating various reports relevant to the running and execution of the pipeline. This will allow you to troubleshoot errors with the running of the pipeline, and also provide you with other information such as launch commands, run times and resource usage.