Package picard.analysis
Class CollectQualityYieldMetrics.QualityYieldMetrics
- java.lang.Object
-
- htsjdk.samtools.metrics.MetricBase
-
- picard.analysis.MergeableMetricBase
-
- picard.analysis.CollectQualityYieldMetrics.QualityYieldMetrics
-
- Enclosing class:
- CollectQualityYieldMetrics
public static class CollectQualityYieldMetrics.QualityYieldMetrics extends MergeableMetricBase
A set of metrics used to describe the general quality of a BAM file
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class picard.analysis.MergeableMetricBase
MergeableMetricBase.MergeByAdding, MergeableMetricBase.MergeByAssertEquals, MergeableMetricBase.MergingIsManual, MergeableMetricBase.NoMergingIsDerived, MergeableMetricBase.NoMergingKeepsValue
-
-
Field Summary
Fields Modifier and Type Field Description longPF_BASESThe total number of bases in all PF readslongPF_Q20_BASESThe number of bases in PF reads that achieve quality score 20 or higherlongPF_Q20_EQUIVALENT_YIELDThe sum of quality scores of all bases in PF reads divided by 20longPF_Q30_BASESThe number of bases in PF reads that achieve quality score 30 or higherlongPF_READSThe number of reads that are PF - pass filterlongQ20_BASESThe number of bases in all reads that achieve quality score 20 or higherlongQ20_EQUIVALENT_YIELDThe sum of quality scores of all bases divided by 20longQ30_BASESThe number of bases in all reads that achieve quality score 30 or higherintREAD_LENGTHThe average read length of all the reads (will be fixed for a lane)longTOTAL_BASESThe total number of bases in all readslongTOTAL_READSThe total number of reads in the input file
-
Constructor Summary
Constructors Constructor Description QualityYieldMetrics()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcalculateDerivedFields()Placeholder method that will calculate the derived fields from the other ones.-
Methods inherited from class picard.analysis.MergeableMetricBase
canMerge, merge, merge, mergeIfCan
-
-
-
-
Field Detail
-
TOTAL_READS
public long TOTAL_READS
The total number of reads in the input file
-
PF_READS
public long PF_READS
The number of reads that are PF - pass filter
-
READ_LENGTH
public int READ_LENGTH
The average read length of all the reads (will be fixed for a lane)
-
TOTAL_BASES
public long TOTAL_BASES
The total number of bases in all reads
-
PF_BASES
public long PF_BASES
The total number of bases in all PF reads
-
Q20_BASES
public long Q20_BASES
The number of bases in all reads that achieve quality score 20 or higher
-
PF_Q20_BASES
public long PF_Q20_BASES
The number of bases in PF reads that achieve quality score 20 or higher
-
Q30_BASES
public long Q30_BASES
The number of bases in all reads that achieve quality score 30 or higher
-
PF_Q30_BASES
public long PF_Q30_BASES
The number of bases in PF reads that achieve quality score 30 or higher
-
Q20_EQUIVALENT_YIELD
public long Q20_EQUIVALENT_YIELD
The sum of quality scores of all bases divided by 20
-
PF_Q20_EQUIVALENT_YIELD
public long PF_Q20_EQUIVALENT_YIELD
The sum of quality scores of all bases in PF reads divided by 20
-
-
Method Detail
-
calculateDerivedFields
public void calculateDerivedFields()
Description copied from class:MergeableMetricBasePlaceholder method that will calculate the derived fields from the other ones. Classes that are derived from non-trivial derived classes should consider calling super.calculateDerivedFields() as well. Fields whose value will change due to this method should be annotated withNoMergingKeepsValue.- Overrides:
calculateDerivedFieldsin classMergeableMetricBase
-
-