Package picard.analysis
Class CollectQualityYieldMetricsFlow
java.lang.Object
picard.cmdline.CommandLineProgram
picard.analysis.SinglePassSamProgram
picard.analysis.CollectQualityYieldMetricsFlow
Command line program to calculate quality yield metrics for flow based read files
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
static class
A set of metrics used to describe the general quality of a BAM file -
Field Summary
FieldsFields inherited from class picard.analysis.SinglePassSamProgram
ASSUME_SORTED, INPUT, output, OUTPUT, STOP_AFTER
Fields inherited from class picard.cmdline.CommandLineProgram
COMPRESSION_LEVEL, CREATE_INDEX, CREATE_MD5_FILE, MAX_ALLOWABLE_ONE_LINE_SUMMARY_LENGTH, MAX_RECORDS_IN_RAM, QUIET, REFERENCE_SEQUENCE, referenceSequence, specialArgumentsCollection, SYNTAX_TRANSITION_URL, TMP_DIR, USE_JDK_DEFLATER, USE_JDK_INFLATER, VALIDATION_STRINGENCY, VERBOSITY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
acceptRead
(htsjdk.samtools.SAMRecord rec, htsjdk.samtools.reference.ReferenceSequence ref) Should be implemented by subclasses to accept SAMRecords one at a time.protected void
finish()
Should be implemented by subclasses to do one-time finalization work.protected void
Should be implemented by subclasses to do one-time initialization work.protected boolean
Ensure that we get all reads regardless of alignment status.Methods inherited from class picard.analysis.SinglePassSamProgram
doWork, getOutputArgumentCollection, makeItSo, setReferenceSequence
Methods inherited from class picard.cmdline.CommandLineProgram
checkRInstallation, customCommandLineValidation, getCommandLine, getCommandLineParser, getCommandLineParserForArgs, getDefaultHeaders, getFaqLink, getMetricsFile, getPGRecord, getStandardUsagePreamble, getStandardUsagePreamble, getVersion, hasWebDocumentation, instanceMain, instanceMainWithExit, makeReferenceArgumentCollection, parseArgs, requiresReference, setDefaultHeaders, useLegacyParser
-
Field Details
-
qualityHistogram
-
INCLUDE_SECONDARY_ALIGNMENTS
@Argument(doc="If true, include bases from secondary alignments in metrics. Setting to true may cause double-counting of bases if there are secondary alignments in the input file.") public boolean INCLUDE_SECONDARY_ALIGNMENTS -
INCLUDE_SUPPLEMENTAL_ALIGNMENTS
@Argument(doc="If true, include bases from supplemental alignments in metrics. Setting to true may cause double-counting of bases if there are supplemental alignments in the input file.") public boolean INCLUDE_SUPPLEMENTAL_ALIGNMENTS -
INCLUDE_BQ_HISTOGRAM
@Argument(doc="Determines whether to include the flow quality histogram in the metrics file.") public boolean INCLUDE_BQ_HISTOGRAM -
fbargs
-
-
Constructor Details
-
CollectQualityYieldMetricsFlow
public CollectQualityYieldMetricsFlow()
-
-
Method Details
-
usesNoRefReads
protected boolean usesNoRefReads()Ensure that we get all reads regardless of alignment status.- Overrides:
usesNoRefReads
in classSinglePassSamProgram
-
setup
Description copied from class:SinglePassSamProgram
Should be implemented by subclasses to do one-time initialization work.- Specified by:
setup
in classSinglePassSamProgram
-
acceptRead
protected void acceptRead(htsjdk.samtools.SAMRecord rec, htsjdk.samtools.reference.ReferenceSequence ref) Description copied from class:SinglePassSamProgram
Should be implemented by subclasses to accept SAMRecords one at a time. If the read has a reference sequence and a reference sequence file was supplied to the program it will be passed as 'ref'. Otherwise 'ref' may be null.- Specified by:
acceptRead
in classSinglePassSamProgram
-
finish
protected void finish()Description copied from class:SinglePassSamProgram
Should be implemented by subclasses to do one-time finalization work.- Specified by:
finish
in classSinglePassSamProgram
-