Package picard.analysis
Class AlignmentSummaryMetrics
java.lang.Object
htsjdk.samtools.metrics.MetricBase
picard.metrics.MultilevelMetrics
picard.analysis.AlignmentSummaryMetrics
@DocumentedFeature(groupName="Metrics",
groupSummary="Metrics",
summary="Alignment metrics")
public class AlignmentSummaryMetrics
extends MultilevelMetrics
High level metrics about the alignment of reads within a SAM file, produced by
the CollectAlignmentSummaryMetrics program and usually stored in a file with
the extension ".alignment_summary_metrics".
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptiondouble
The average length of the soft-clipped bases at the 3' end of reads.long
The number of instrument cycles in which 80% or more of base calls were no-calls.One of either UNPAIRED (for a fragment run), FIRST_OF_PAIR when metrics are for only the first read in a paired run, SECOND_OF_PAIR when the metrics are for only the second read in a paired run or PAIR when the metrics are aggregated for both first and second reads in a pair.double
The median absolute deviation of the distribution of all read lengths.double
The maximum read length.double
The mean aligned read length of the set of reads examined.double
The mean read length of the set of reads examined.double
The median read length of the set of reads examined.double
The minimum read length.double
The fraction of PF reads that are unaligned or aligned with MQ0 and match to a known adapter sequence right from the start of the read (indication of adapter-dimer pairs).double
The fraction of reads that map outside of a maximum insert size (usually 100kb) or that have the two ends mapping to different chromosomes.double
The fraction of PF bases that are (on primary, aligned reads and) hard-clipped, as a fraction of the PF_ALIGNED_BASES (even though these are not aligned!)double
The fraction of reads that are PF (PF_READS / TOTAL_READS)double
The percentage of PF reads that aligned to the reference sequence.double
The fraction of (primary) reads that are *not* "properly" aligned in pairs (as per SAM flag 0x2).double
The fraction of aligned reads whose mate pair was also aligned to the reference.double
the fraction of PF bases that are on (primary) aligned reads and are soft-clipped, as a fraction of the PF_ALIGNED_BASES (even though these are not aligned!)long
The total number of aligned bases, in all mapped PF reads, that are aligned to the reference sequence.long
The number of bases aligned to the reference sequence in reads that were mapped at high quality.long
The subset of PF_HQ_ALIGNED_BASES where the base call quality was Q20 or higher.long
The number of PF reads that were aligned to the reference sequence with a mapping quality of Q20 or higher signifying that the aligner estimates a 1/100 (or smaller) chance that the alignment is wrong.double
The fraction of bases that mismatch the reference in PF HQ aligned reads.double
The median number of mismatches versus the reference sequence in reads that were aligned to the reference at high quality (i.e.double
The number of insertion and deletion events per 100 aligned bases.double
The rate of bases mismatching the reference for all bases aligned to the reference sequence.long
The number of PF reads that are marked as noise reads.long
The number of PF reads where PF is defined as passing Illumina's filter.long
The number of PF reads that were aligned to the reference sequence.long
The number of (primary) aligned reads that are **not** "properly" aligned in pairs (as per SAM flag 0x2).long
The number of aligned reads whose mate pair was also aligned to the reference.double
The standard deviation of the read lengths.double
The number of PF reads aligned to the positive strand of the genome divided by the number of PF reads aligned to the genome.long
The total number of reads including all PF and non-PF reads.Fields inherited from class picard.metrics.MultilevelMetrics
LIBRARY, READ_GROUP, SAMPLE
-
Constructor Summary
Constructors -
Method Summary
Methods inherited from class htsjdk.samtools.metrics.MetricBase
equals, hashCode, toString
-
Field Details
-
CATEGORY
One of either UNPAIRED (for a fragment run), FIRST_OF_PAIR when metrics are for only the first read in a paired run, SECOND_OF_PAIR when the metrics are for only the second read in a paired run or PAIR when the metrics are aggregated for both first and second reads in a pair. -
TOTAL_READS
public long TOTAL_READSThe total number of reads including all PF and non-PF reads. When CATEGORY equals PAIR this value will be 2x the number of clusters. -
PF_READS
public long PF_READSThe number of PF reads where PF is defined as passing Illumina's filter. -
PCT_PF_READS
public double PCT_PF_READSThe fraction of reads that are PF (PF_READS / TOTAL_READS) -
PF_NOISE_READS
public long PF_NOISE_READSThe number of PF reads that are marked as noise reads. A noise read is one which is composed entirely of A bases and/or N bases. These reads are marked as they are usually artifactual and are of no use in downstream analysis. -
PF_READS_ALIGNED
public long PF_READS_ALIGNEDThe number of PF reads that were aligned to the reference sequence. This includes reads that aligned with low quality (i.e. their alignments are ambiguous). -
PCT_PF_READS_ALIGNED
public double PCT_PF_READS_ALIGNEDThe percentage of PF reads that aligned to the reference sequence. PF_READS_ALIGNED / PF_READS -
PF_ALIGNED_BASES
public long PF_ALIGNED_BASESThe total number of aligned bases, in all mapped PF reads, that are aligned to the reference sequence. -
PF_HQ_ALIGNED_READS
public long PF_HQ_ALIGNED_READSThe number of PF reads that were aligned to the reference sequence with a mapping quality of Q20 or higher signifying that the aligner estimates a 1/100 (or smaller) chance that the alignment is wrong. -
PF_HQ_ALIGNED_BASES
public long PF_HQ_ALIGNED_BASESThe number of bases aligned to the reference sequence in reads that were mapped at high quality. Will usually approximate PF_HQ_ALIGNED_READS * READ_LENGTH but may differ when either mixed read lengths are present or many reads are aligned with gaps. -
PF_HQ_ALIGNED_Q20_BASES
public long PF_HQ_ALIGNED_Q20_BASESThe subset of PF_HQ_ALIGNED_BASES where the base call quality was Q20 or higher. -
PF_HQ_MEDIAN_MISMATCHES
public double PF_HQ_MEDIAN_MISMATCHESThe median number of mismatches versus the reference sequence in reads that were aligned to the reference at high quality (i.e. PF_HQ_ALIGNED READS). -
PF_MISMATCH_RATE
public double PF_MISMATCH_RATEThe rate of bases mismatching the reference for all bases aligned to the reference sequence. -
PF_HQ_ERROR_RATE
public double PF_HQ_ERROR_RATEThe fraction of bases that mismatch the reference in PF HQ aligned reads. -
PF_INDEL_RATE
public double PF_INDEL_RATEThe number of insertion and deletion events per 100 aligned bases. Uses the number of events as the numerator, not the number of inserted or deleted bases. -
MEAN_READ_LENGTH
public double MEAN_READ_LENGTHThe mean read length of the set of reads examined. When looking at the data for a single lane with equal length reads this number is just the read length. When looking at data for merged lanes with differing read lengths this is the mean read length of all reads. Computed using all read lengths including clipped bases. -
SD_READ_LENGTH
public double SD_READ_LENGTHThe standard deviation of the read lengths. Computed using all read lengths including clipped bases. -
MEDIAN_READ_LENGTH
public double MEDIAN_READ_LENGTHThe median read length of the set of reads examined. When looking at the data for a single lane with equal length reads this number is just the read length. When looking at data for merged lanes with differing read lengths this is the median read length of all reads. Computed using all bases in reads, including clipped bases. -
MAD_READ_LENGTH
public double MAD_READ_LENGTHThe median absolute deviation of the distribution of all read lengths. If the distribution is essentially normal then the standard deviation can be estimated as ~1.4826 * MAD. Computed using all read lengths including clipped bases. -
MIN_READ_LENGTH
public double MIN_READ_LENGTHThe minimum read length. Computed using all read lengths including clipped bases. -
MAX_READ_LENGTH
public double MAX_READ_LENGTHThe maximum read length. Computed using all read lengths including clipped bases. -
MEAN_ALIGNED_READ_LENGTH
public double MEAN_ALIGNED_READ_LENGTHThe mean aligned read length of the set of reads examined. When looking at the data for a single lane with equal length reads this number is just the read length. When looking at data for merged lanes with differing read lengths this is the mean read length of all reads. Clipped bases are not counted. -
READS_ALIGNED_IN_PAIRS
public long READS_ALIGNED_IN_PAIRSThe number of aligned reads whose mate pair was also aligned to the reference. -
PCT_READS_ALIGNED_IN_PAIRS
public double PCT_READS_ALIGNED_IN_PAIRSThe fraction of aligned reads whose mate pair was also aligned to the reference. READS_ALIGNED_IN_PAIRS / PF_READS_ALIGNED -
PF_READS_IMPROPER_PAIRS
public long PF_READS_IMPROPER_PAIRSThe number of (primary) aligned reads that are **not** "properly" aligned in pairs (as per SAM flag 0x2). -
PCT_PF_READS_IMPROPER_PAIRS
public double PCT_PF_READS_IMPROPER_PAIRSThe fraction of (primary) reads that are *not* "properly" aligned in pairs (as per SAM flag 0x2). PF_READS_IMPROPER_PAIRS / PF_READS_ALIGNED -
BAD_CYCLES
public long BAD_CYCLESThe number of instrument cycles in which 80% or more of base calls were no-calls. -
STRAND_BALANCE
public double STRAND_BALANCEThe number of PF reads aligned to the positive strand of the genome divided by the number of PF reads aligned to the genome. -
PCT_CHIMERAS
public double PCT_CHIMERASThe fraction of reads that map outside of a maximum insert size (usually 100kb) or that have the two ends mapping to different chromosomes. -
PCT_ADAPTER
public double PCT_ADAPTERThe fraction of PF reads that are unaligned or aligned with MQ0 and match to a known adapter sequence right from the start of the read (indication of adapter-dimer pairs). -
PCT_SOFTCLIP
public double PCT_SOFTCLIPthe fraction of PF bases that are on (primary) aligned reads and are soft-clipped, as a fraction of the PF_ALIGNED_BASES (even though these are not aligned!) -
PCT_HARDCLIP
public double PCT_HARDCLIPThe fraction of PF bases that are (on primary, aligned reads and) hard-clipped, as a fraction of the PF_ALIGNED_BASES (even though these are not aligned!) -
AVG_POS_3PRIME_SOFTCLIP_LENGTH
public double AVG_POS_3PRIME_SOFTCLIP_LENGTHThe average length of the soft-clipped bases at the 3' end of reads. This could be used as an estimate for the amount by which the insert-size must be increased in order to obtain a significant reduction in bases lost due to reading off the end of the insert.
-
-
Constructor Details
-
AlignmentSummaryMetrics
public AlignmentSummaryMetrics()
-