Package org.broadinstitute.hellbender.tools.examples

Class ExamplePartialReadWalker

java.lang.Object

org.broadinstitute.hellbender.cmdline.CommandLineProgram

org.broadinstitute.hellbender.engine.GATKTool

org.broadinstitute.hellbender.engine.WalkerBase

org.broadinstitute.hellbender.engine.ReadWalker

org.broadinstitute.hellbender.engine.PartialReadWalker

org.broadinstitute.hellbender.tools.examples.ExamplePartialReadWalker

All Implemented Interfaces:

org.broadinstitute.barclay.argparser.CommandLinePluginProvider

public final class ExamplePartialReadWalker
extends PartialReadWalker

Example/toy program that prints reads from the provided file or files with corresponding reference bases (if a reference is provided). Intended to show how to implement the ReadWalker interface.

Nested Class Summary

Nested classes/interfaces inherited from class org.broadinstitute.hellbender.cmdline.CommandLineProgram

CommandLineProgram.AutoCloseableNoCheckedExceptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FULL_NAME_STOP_ON_READ_NAME
String	stopOnReadName

Fields inherited from class org.broadinstitute.hellbender.engine.ReadWalker

FEATURE_CACHE_LOOKAHEAD

Fields inherited from class org.broadinstitute.hellbender.engine.GATKTool

addOutputSAMProgramRecord, addOutputVCFCommandLine, cloudIndexPrefetchBuffer, cloudPrefetchBuffer, createOutputBamIndex, createOutputBamMD5, createOutputVariantIndex, createOutputVariantMD5, disableBamIndexCaching, features, intervalArgumentCollection, lenientVCFProcessing, outputSitesOnlyVCFs, progressMeter, readArguments, referenceArguments, SECONDS_BETWEEN_PROGRESS_UPDATES_NAME, seqValidationArguments

Fields inherited from class org.broadinstitute.hellbender.cmdline.CommandLineProgram

GATK_CONFIG_FILE, logger, NIO_MAX_REOPENS, NIO_PROJECT_FOR_REQUESTER_PAYS, QUIET, specialArgumentsCollection, tmpDir, useJdkDeflater, useJdkInflater, VERBOSITY

Constructor Summary

Constructors

Constructor	Description
ExamplePartialReadWalker()

Method Summary

Modifier and Type	Method	Description
void	apply(GATKRead read, ReferenceContext referenceContext, FeatureContext featureContext)	Process an individual read (with optional contextual information).
void	closeTool()	This method is called by the GATK framework at the end of the GATKTool.doWork() template method.
void	onTraversalStart()	Operations performed just prior to the start of traversal.
protected boolean	shouldExitEarly(GATKRead read)	Method to be overridden by the implementation class to determine when to stop the read stream traversal

Methods inherited from class org.broadinstitute.hellbender.engine.PartialReadWalker

traverse

Methods inherited from class org.broadinstitute.hellbender.engine.ReadWalker

getDefaultReadFilters, getProgressMeterRecordLabel, onShutdown, onStartup, requiresReads, resetReadsDataSource

Methods inherited from class org.broadinstitute.hellbender.engine.WalkerBase

directlyAccessEngineFeatureManager, directlyAccessEngineReadsDataSource, directlyAccessEngineReferenceDataSource

Methods inherited from class org.broadinstitute.hellbender.engine.GATKTool

addFeatureInputsAfterInitialization, bamIndexCachingShouldBeEnabled, createSAMWriter, createVCFWriter, createVCFWriter, createVCFWriter, disableProgressMeter, doWork, getBestAvailableSequenceDictionary, getDefaultCloudIndexPrefetchBufferSize, getDefaultCloudPrefetchBufferSize, getDefaultToolVCFHeaderLines, getDefaultVariantAnnotationGroups, getDefaultVariantAnnotations, getGenomicsDBOptions, getHeaderForFeatures, getHeaderForReads, getHeaderForSAMWriter, getMasterSequenceDictionary, getPluginDescriptors, getReferenceDictionary, getSequenceDictionaryValidationArgumentCollection, getToolName, getTransformedReadStream, getTraversalIntervals, getUserSuppliedIntervals, hasFeatures, hasReads, hasReference, hasUserSuppliedIntervals, initializeProgressMeter, makePostReadFilterTransformer, makePreReadFilterTransformer, makeReadFilter, makeSamReaderFactory, makeVariantAnnotations, onTraversalSuccess, requiresFeatures, requiresIntervals, requiresReference, transformTraversalIntervals, useVariantAnnotations

Methods inherited from class org.broadinstitute.hellbender.cmdline.CommandLineProgram

customCommandLineValidation, getCommandLine, getCommandLineParser, getDefaultHeaders, getMetricsFile, getSupportInformation, getToolkitName, getToolkitShortName, getToolStatusWarning, getUsage, getVersion, instanceMain, instanceMainPostParseArgs, isBetaFeature, isExperimentalFeature, parseArgs, printLibraryVersions, printSettings, printStartupMessage, runTool, setDefaultHeaders, warnOnToolStatus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FULL_NAME_STOP_ON_READ_NAME

public static final String FULL_NAME_STOP_ON_READ_NAME

See Also:

• Constant Field Values

stopOnReadName

@Argument(fullName="stop-on-read-name",
          doc="stop when a read by this name is encountered")
public String stopOnReadName

Constructor Details

ExamplePartialReadWalker

public ExamplePartialReadWalker()

Method Details

onTraversalStart

public void onTraversalStart()

Description copied from class: GATKTool

Operations performed just prior to the start of traversal. Should be overridden by tool authors who need to process arguments local to their tool or perform other kinds of local initialization. Default implementation does nothing.

Overrides:

onTraversalStart in class GATKTool

apply

public void apply(GATKRead read,
 ReferenceContext referenceContext,
 FeatureContext featureContext)

Description copied from class: ReadWalker

Process an individual read (with optional contextual information). Must be implemented by tool authors. In general, tool authors should simply stream their output from apply(), and maintain as little internal state as possible. TODO: Determine whether and to what degree the GATK engine should provide a reduce operation TODO: to complement this operation. At a minimum, we should make apply() return a value to TODO: discourage statefulness in walkers, but how this value should be handled is TBD.

Specified by:

apply in class ReadWalker

Parameters:

read - current read

referenceContext - Reference bases spanning the current read. Will be an empty, but non-null, context object if there is no backing source of reference data (in which case all queries on it will return an empty array/iterator). Can request extra bases of context around the current read's interval by invoking ReferenceContext.setWindow(int, int) on this object before calling ReferenceContext.getBases()

featureContext - Features spanning the current read. Will be an empty, but non-null, context object if there is no backing source of Feature data (in which case all queries on it will return an empty List).

closeTool

public void closeTool()

Description copied from class: GATKTool

This method is called by the GATK framework at the end of the GATKTool.doWork() template method. It is called regardless of whether the GATKTool.traverse() has succeeded or not. It is called after the GATKTool.onTraversalSuccess() has completed (successfully or not) but before the GATKTool.doWork() method returns. In other words, on successful runs both GATKTool.onTraversalSuccess() and GATKTool.closeTool() will be called (in this order) while on failed runs (when GATKTool.traverse() causes an exception), only GATKTool.closeTool() will be called. The default implementation does nothing. Subclasses should override this method to close any resources that must be closed regardless of the success of traversal.

Overrides:

closeTool in class GATKTool

shouldExitEarly

protected boolean shouldExitEarly(GATKRead read)

Description copied from class: PartialReadWalker

Method to be overridden by the implementation class to determine when to stop the read stream traversal

Specified by:

shouldExitEarly in class PartialReadWalker

Parameters:

read - - the read to be processed next (in case it is needed)

Returns:

boolean indicator: true means stop!