Class CollectAllelicCountsSpark
java.lang.Object
org.broadinstitute.hellbender.cmdline.CommandLineProgram
org.broadinstitute.hellbender.engine.spark.SparkCommandLineProgram
org.broadinstitute.hellbender.engine.spark.GATKSparkTool
org.broadinstitute.hellbender.engine.spark.LocusWalkerSpark
org.broadinstitute.hellbender.tools.copynumber.CollectAllelicCountsSpark
- All Implemented Interfaces:
Serializable
,org.broadinstitute.barclay.argparser.CommandLinePluginProvider
See
CollectAllelicCounts
. This behaves the same, except that it supports spark.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.broadinstitute.hellbender.engine.spark.GATKSparkTool
GATKSparkTool.ReadInputMergingPolicy
Nested classes/interfaces inherited from class org.broadinstitute.hellbender.cmdline.CommandLineProgram
CommandLineProgram.AutoCloseableNoCheckedExceptions
-
Field Summary
Fields inherited from class org.broadinstitute.hellbender.engine.spark.LocusWalkerSpark
maxDepthPerSample, readShardSize, shuffle
Fields inherited from class org.broadinstitute.hellbender.engine.spark.GATKSparkTool
addOutputVCFCommandLine, BAM_PARTITION_SIZE_LONG_NAME, bamPartitionSplitSize, CREATE_OUTPUT_BAM_SPLITTING_INDEX_LONG_NAME, createOutputBamIndex, createOutputBamSplittingIndex, createOutputVariantIndex, features, intervalArgumentCollection, NUM_REDUCERS_LONG_NAME, numReducers, OUTPUT_SHARD_DIR_LONG_NAME, readArguments, referenceArguments, sequenceDictionaryValidationArguments, SHARDED_OUTPUT_LONG_NAME, shardedOutput, shardedPartsDir, SPLITTING_INDEX_GRANULARITY, splittingIndexGranularity, USE_NIO, useNio
Fields inherited from class org.broadinstitute.hellbender.engine.spark.SparkCommandLineProgram
programName, SPARK_PROGRAM_NAME_LONG_NAME, sparkArgs
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 -
Method Summary
Modifier and TypeMethodDescriptionboolean
Does this tool emit information for uncovered loci? Tools that do should override to returntrue
.Returns the default list of ReadFilters that are used for this tool.protected void
processAlignments
(org.apache.spark.api.java.JavaRDD<LocusWalkerContext> rdd, org.apache.spark.api.java.JavaSparkContext ctx) Process the alignments and write output.boolean
Does this tool require intervals? Tools that do should override to return true.boolean
Does this tool require reference data? Tools that do should override to return true.Methods inherited from class org.broadinstitute.hellbender.engine.spark.LocusWalkerSpark
defaultMaxDepthPerSample, getAlignments, getDownsamplingInfo, requiresReads, runTool
Methods inherited from class org.broadinstitute.hellbender.engine.spark.GATKSparkTool
addReferenceFilesForSpark, addVCFsForSpark, editIntervals, getBestAvailableSequenceDictionary, getDefaultToolVCFHeaderLines, getDefaultVariantAnnotationGroups, getDefaultVariantAnnotations, getGatkReadJavaRDD, getHeaderForReads, getHeaderForReadsInput, getIntervals, getPluginDescriptors, getReadInputMergingPolicy, getReads, getReadSourceName, getRecommendedNumReducers, getReference, getReferenceSequenceDictionary, getReferenceWindowFunction, getSequenceDictionaryValidationArgumentCollection, getTargetPartitionSize, getUnfilteredReads, hasReads, hasReference, hasUserSuppliedIntervals, makeReadFilter, makeReadFilter, makeVariantAnnotations, runPipeline, useVariantAnnotations, validateSequenceDictionaries, writeReads, writeReads
Methods inherited from class org.broadinstitute.hellbender.engine.spark.SparkCommandLineProgram
afterPipeline, doWork, getProgramName
Methods inherited from class org.broadinstitute.hellbender.cmdline.CommandLineProgram
customCommandLineValidation, getCommandLine, getCommandLineParser, getDefaultHeaders, getMetricsFile, getSupportInformation, getToolkitName, getToolkitShortName, getToolStatusWarning, getUsage, getVersion, instanceMain, instanceMainPostParseArgs, isBetaFeature, isExperimentalFeature, onShutdown, onStartup, parseArgs, printLibraryVersions, printSettings, printStartupMessage, runTool, setDefaultHeaders, warnOnToolStatus
-
Constructor Details
-
CollectAllelicCountsSpark
public CollectAllelicCountsSpark()
-
-
Method Details
-
emitEmptyLoci
public boolean emitEmptyLoci()Description copied from class:LocusWalkerSpark
Does this tool emit information for uncovered loci? Tools that do should override to returntrue
. NOTE: Typically, this should only be used when intervals are specified. NOTE: If MappedReadFilter is removed, then emitting empty loci will fail. NOTE: If there is no available sequence dictionary and this is set to true, there should be a failure. Please consider requiring reads and/or references for all tools that wish to set this totrue
.- Overrides:
emitEmptyLoci
in classLocusWalkerSpark
- Returns:
true
if this tool requires uncovered loci information to be emitted,false
otherwise
-
requiresReference
public boolean requiresReference()Description copied from class:GATKSparkTool
Does this tool require reference data? Tools that do should override to return true.- Overrides:
requiresReference
in classGATKSparkTool
- Returns:
- true if this tool requires a reference, otherwise false
-
requiresIntervals
public boolean requiresIntervals()Description copied from class:GATKSparkTool
Does this tool require intervals? Tools that do should override to return true.- Overrides:
requiresIntervals
in classGATKSparkTool
- Returns:
- true if this tool requires intervals, otherwise false
-
getDefaultReadFilters
Description copied from class:GATKSparkTool
Returns the default list of ReadFilters that are used for this tool. The filters returned by this method are subject to selective enabling/disabling by the user via the command line. The default implementation uses theWellformedReadFilter
filter with all default options. Subclasses can override to provide alternative filters. Note: this method is called before command line parsing begins, and thus before a SAMFileHeader is available throughGATKSparkTool.getHeaderForReads()
. The actual SAMFileHeader is propagated to the read filters byGATKSparkTool.makeReadFilter()
after the filters have been merged with command line arguments.- Overrides:
getDefaultReadFilters
in classGATKSparkTool
- Returns:
- List of individual filters to be applied for this tool.
-
processAlignments
protected void processAlignments(org.apache.spark.api.java.JavaRDD<LocusWalkerContext> rdd, org.apache.spark.api.java.JavaSparkContext ctx) Description copied from class:LocusWalkerSpark
Process the alignments and write output. Must be implemented by subclasses.- Specified by:
processAlignments
in classLocusWalkerSpark
- Parameters:
rdd
- a distributed collection ofLocusWalkerContext
ctx
- our Spark context
-