Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Tool Reference

Auto-generated from fgumi command definitions.

ALIGNMENT

CommandDescription
fastqConvert BAM to FASTQ format
zipperZip unmapped BAM with aligned BAM
sortSort BAM file by coordinate, queryname, or template-coordinate
mergeMerge pre-sorted BAM files into a single sorted BAM

CONSENSUS

CommandDescription
simplexCall simplex consensus sequences from UMI-grouped reads
duplexCall duplex consensus sequences from UMI-grouped reads
codecCall CODEC consensus reads from grouped BAM

DEDUP

CommandDescription
dedupMark or remove PCR duplicates using UMI information

GROUP

CommandDescription
groupGroup reads by UMI to identify reads from the same original molecule

POST-CONSENSUS

CommandDescription
filterFilter consensus reads based on quality metrics
clipClip overlapping reads in BAM files
duplex-metricsCollect QC metrics for duplex consensus reads
reviewExtract data to review variant calls from consensus reads
simplex-metricsCollect QC metrics for simplex sequencing data

UMI EXTRACTION

CommandDescription
extractExtract UMIs from FASTQ and create unmapped BAM
correctCorrect UMIs in a BAM file to a fixed set of UMIs

UTILITIES

CommandDescription
downsampleDownsample BAM by UMI family using streaming