Package picard.analysis
Class CollectBaseDistributionByCycle
- java.lang.Object
-
- picard.cmdline.CommandLineProgram
-
- picard.analysis.SinglePassSamProgram
-
- picard.analysis.CollectBaseDistributionByCycle
-
@DocumentedFeature public class CollectBaseDistributionByCycle extends SinglePassSamProgram
-
-
Field Summary
Fields Modifier and Type Field Description boolean
ALIGNED_READS_ONLY
File
CHART_OUTPUT
boolean
PF_READS_ONLY
-
Fields 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, GA4GH_CLIENT_SECRETS, 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 Constructor Description CollectBaseDistributionByCycle()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
acceptRead(htsjdk.samtools.SAMRecord rec, htsjdk.samtools.reference.ReferenceSequence ref)
Should be implemented by subclasses to accept SAMRecords one at a time.protected String[]
customCommandLineValidation()
Put any custom command-line validation in an override of this method.protected void
finish()
Should be implemented by subclasses to do one-time finalization work.protected void
setup(htsjdk.samtools.SAMFileHeader header, File samFile)
Should be implemented by subclasses to do one-time initialization work.-
Methods inherited from class picard.analysis.SinglePassSamProgram
doWork, getOutputArgumentCollection, makeItSo, setReferenceSequence, usesNoRefReads
-
Methods inherited from class picard.cmdline.CommandLineProgram
checkRInstallation, getCommandLine, getCommandLineParser, getCommandLineParserForArgs, getDefaultHeaders, getFaqLink, getMetricsFile, getPGRecord, getStandardUsagePreamble, getStandardUsagePreamble, getVersion, hasWebDocumentation, instanceMain, instanceMainWithExit, makeReferenceArgumentCollection, parseArgs, requiresReference, setDefaultHeaders, useLegacyParser
-
-
-
-
Field Detail
-
CHART_OUTPUT
@Argument(shortName="CHART", doc="A file (with .pdf extension) to write the chart to.") public File CHART_OUTPUT
-
ALIGNED_READS_ONLY
@Argument(doc="If set to true, calculate the base distribution over aligned reads only.") public boolean ALIGNED_READS_ONLY
-
PF_READS_ONLY
@Argument(doc="If set to true, calculate the base distribution over PF reads only (Illumina specific). PF reads are reads that passed the internal quality filters applied by Illumina sequencers.") public boolean PF_READS_ONLY
-
-
Method Detail
-
customCommandLineValidation
protected String[] customCommandLineValidation()
Description copied from class:CommandLineProgram
Put any custom command-line validation in an override of this method. clp is initialized at this point and can be used to print usage and access argv. Any options set by command-line parser can be validated.- Overrides:
customCommandLineValidation
in classCommandLineProgram
- Returns:
- null if command line is valid. If command line is invalid, returns an array of error message to be written to the appropriate place.
-
setup
protected void setup(htsjdk.samtools.SAMFileHeader header, File samFile)
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
-
-