Mercurial > repos > jjohnson > gatk2
diff depth_of_coverage.xml @ 0:74c05070a3f8 draft
Uploaded
author | jjohnson |
---|---|
date | Thu, 01 Nov 2012 13:53:22 -0400 |
parents | |
children | 7533db8dfb5b |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/depth_of_coverage.xml Thu Nov 01 13:53:22 2012 -0400 @@ -0,0 +1,1030 @@ +<tool id="gatk2_depth_of_coverage" name="Depth of Coverage" version="0.0.4"> + <description>on BAM files</description> + <requirements> + <requirement type="package" version="2.2">gatk</requirement> + <requirement type="package" version="0.1.18">samtools</requirement> + </requirements> + <command interpreter="python">gatk2_wrapper.py + --max_jvm_heap_fraction "1" + --stdout "${output_log}" + #for $i, $input_bam in enumerate( $reference_source.input_bams ): + -d "-I" "${input_bam.input_bam}" "${input_bam.input_bam.ext}" "gatk_input_${i}" + #if str( $input_bam.input_bam.metadata.bam_index ) != "None": + -d "" "${input_bam.input_bam.metadata.bam_index}" "bam_index" "gatk_input_${i}" ##hardcode galaxy ext type as bam_index + #end if + #end for + -p 'java + -jar "\$GATK2_PATH/GenomeAnalysisTK.jar" + -T "DepthOfCoverage" + \$GATK2_SITE_OPTIONS + ##--num_threads 4 ##hard coded, for now + + ##-et "NO_ET" -K "/data/galaxy/appList/GenomeAnalysisTK-2.0-36-gf5c1c1a/gatk2_key_file" ##ET no phone home + #if $reference_source.reference_source_selector != "history": + -R "${reference_source.ref_file.fields.path}" + #end if + #if str( $input_calculate_coverage_over_genes ) != "None": + --calculateCoverageOverGenes "${input_calculate_coverage_over_genes}" + #end if + #if str( $partition_type ) != "None": + #for $pt in str( $partition_type ).split( ',' ): + --partitionType "${pt}" + #end for + #end if + --out "${output_per_locus_coverage}" + + #for $ct_group in $summary_coverage_threshold_group: + --summaryCoverageThreshold "${ct_group.summary_coverage_threshold}" + #end for + --outputFormat "${output_format}" + ' + + ##start standard gatk options + #if $gatk_param_type.gatk_param_type_selector == "advanced": + #for $pedigree in $gatk_param_type.pedigree: + -p '--pedigree "${pedigree.pedigree_file}"' + #end for + #for $pedigree_string in $gatk_param_type.pedigree_string_repeat: + -p '--pedigreeString "${pedigree_string.pedigree_string}"' + #end for + -p '--pedigreeValidationType "${gatk_param_type.pedigree_validation_type}"' + #for $read_filter in $gatk_param_type.read_filter: + -p '--read_filter "${read_filter.read_filter_type.read_filter_type_selector}" + ###raise Exception( str( dir( $read_filter ) ) ) + #for $name, $param in $read_filter.read_filter_type.iteritems(): + #if $name not in [ "__current_case__", "read_filter_type_selector" ]: + #if hasattr( $param.input, 'truevalue' ): + ${param} + #else: + --${name} "${param}" + #end if + #end if + #end for + ' + #end for + #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_interval_repeat ): + -d "--intervals" "${input_intervals.input_intervals}" "${input_intervals.input_intervals.ext}" "input_intervals_${interval_count}" + #end for + + #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_exclude_interval_repeat ): + -d "--excludeIntervals" "${input_intervals.input_exclude_intervals}" "${input_intervals.input_exclude_intervals.ext}" "input_exlude_intervals_${interval_count}" + #end for + + -p '--interval_set_rule "${gatk_param_type.interval_set_rule}"' + + -p '--downsampling_type "${gatk_param_type.downsampling_type.downsampling_type_selector}"' + #if str( $gatk_param_type.downsampling_type.downsampling_type_selector ) != "NONE": + -p '--${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_type_selector} "${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_value}"' + #end if + -p ' + --baq "${gatk_param_type.baq}" + --baqGapOpenPenalty "${gatk_param_type.baq_gap_open_penalty}" + ${gatk_param_type.use_original_qualities} + --defaultBaseQualities "${gatk_param_type.default_base_qualities}" + --validation_strictness "${gatk_param_type.validation_strictness}" + --interval_merging "${gatk_param_type.interval_merging}" + ${gatk_param_type.disable_experimental_low_memory_sharding} + ${gatk_param_type.non_deterministic_random_seed} + ' + #for $rg_black_list_count, $rg_black_list in enumerate( $gatk_param_type.read_group_black_list_repeat ): + #if $rg_black_list.read_group_black_list_type.read_group_black_list_type_selector == "file": + -d "--read_group_black_list" "${rg_black_list.read_group_black_list_type.read_group_black_list}" "txt" "input_read_group_black_list_${rg_black_list_count}" + #else + -p '--read_group_black_list "${rg_black_list.read_group_black_list_type.read_group_black_list}"' + #end if + #end for + #end if + + #if $reference_source.reference_source_selector == "history": + -d "-R" "${reference_source.ref_file}" "${reference_source.ref_file.ext}" "gatk_input" + #end if + ##end standard gatk options + ##start analysis specific options + #if $analysis_param_type.analysis_param_type_selector == "advanced": + -p ' + ${analysis_param_type.ignore_deletion_sites} + ${analysis_param_type.include_deletions} + --maxBaseQuality "${analysis_param_type.max_base_quality}" + --maxMappingQuality "${analysis_param_type.max_mapping_quality}" + --minBaseQuality "${analysis_param_type.min_base_quality}" + --minMappingQuality "${analysis_param_type.min_mapping_quality}" + --nBins "${analysis_param_type.n_bins}" + ${analysis_param_type.omit_depth_output_at_each_base} + ${analysis_param_type.omit_interval_statistics} + ${analysis_param_type.omit_locus_table} + ${analysis_param_type.omit_per_sample_stats} + ${analysis_param_type.print_base_counts} + ${analysis_param_type.print_bin_endpoints_and_exit} + --start "${analysis_param_type.start}" + --stop "${analysis_param_type.stop}" + ' + #end if + ##Move additional files to final location + #if str( $partition_type ) != "None": + #set $partition_types = str( $partition_type ).split( ',' ) + #else: + #set $partition_types = [ 'sample' ] + #end if + #if 'sample' in $partition_types and ( str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.print_bin_endpoints_and_exit ) == "" ): + #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_per_sample_stats ) == "": + && mv ${output_per_locus_coverage}.sample_summary ${output_summary_sample} + && mv ${output_per_locus_coverage}.sample_statistics ${output_statistics_sample} + #end if + #if $gatk_param_type.gatk_param_type_selector == "advanced" and len( $gatk_param_type.input_interval_repeat ) and ( str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_interval_statistics ) == "" ): + && mv ${output_per_locus_coverage}.sample_interval_summary ${output_interval_summary_sample} + && mv ${output_per_locus_coverage}.sample_interval_statistics ${output_interval_statistics_sample} + #end if + #if str( $input_calculate_coverage_over_genes ) != "None": + && mv ${output_per_locus_coverage}.sample_gene_summary ${output_gene_summary_sample} + && mv ${output_per_locus_coverage}.sample_gene_statistics ${output_gene_statistics_sample} + #end if + #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "": + && mv ${output_per_locus_coverage}.sample_cumulative_coverage_counts ${output_cumulative_coverage_counts_sample} + && mv ${output_per_locus_coverage}.sample_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_sample} + #end if + #end if + + #if 'readgroup' in $partition_types and ( str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.print_bin_endpoints_and_exit ) == "" ): + #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_per_sample_stats ) == "": + && mv ${output_per_locus_coverage}.read_group_summary ${output_summary_readgroup} + && mv ${output_per_locus_coverage}.read_group_statistics ${output_statistics_readgroup} + #end if + #if $gatk_param_type.gatk_param_type_selector == "advanced" and len( $gatk_param_type.input_interval_repeat ) and ( str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_interval_statistics ) == "" ): + && mv ${output_per_locus_coverage}.read_group_interval_summary ${output_interval_summary_readgroup} + && mv ${output_per_locus_coverage}.read_group_interval_statistics ${output_interval_statistics_readgroup} + #end if + #if str( $input_calculate_coverage_over_genes ) != "None": + && mv ${output_per_locus_coverage}.read_group_gene_summary ${output_gene_summary_readgroup} + && mv ${output_per_locus_coverage}.read_group_gene_statistics ${output_gene_statistics_readgroup} + #end if + #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "": + && mv ${output_per_locus_coverage}.read_group_cumulative_coverage_counts ${output_cumulative_coverage_counts_readgroup} + && mv ${output_per_locus_coverage}.read_group_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_readgroup} + #end if + #end if + + #if 'library' in $partition_types and ( str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.print_bin_endpoints_and_exit ) == "" ): + #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_per_sample_stats ) == "": + && mv ${output_per_locus_coverage}.library_summary ${output_summary_library} + && mv ${output_per_locus_coverage}.library_statistics ${output_statistics_library} + #end if + #if $gatk_param_type.gatk_param_type_selector == "advanced" and len( $gatk_param_type.input_interval_repeat ) and ( str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_interval_statistics ) == "" ): + && mv ${output_per_locus_coverage}.library_interval_summary ${output_interval_summary_library} + && mv ${output_per_locus_coverage}.library_interval_statistics ${output_interval_statistics_library} + #end if + #if str( $input_calculate_coverage_over_genes ) != "None": + && mv ${output_per_locus_coverage}.library_gene_summary ${output_gene_summary_library} + && mv ${output_per_locus_coverage}.library_gene_statistics ${output_gene_statistics_library} + #end if + #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "": + && mv ${output_per_locus_coverage}.library_cumulative_coverage_counts ${output_cumulative_coverage_counts_library} + && mv ${output_per_locus_coverage}.library_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_library} + #end if + #end if + + + </command> + <inputs> + <conditional name="reference_source"> + <param name="reference_source_selector" type="select" label="Choose the source for the reference list"> + <option value="cached">Locally cached</option> + <option value="history">History</option> + </param> + <when value="cached"> + <repeat name="input_bams" title="BAM file" min="1" help="-I,--input_file &lt;input_file&gt;"> + <param name="input_bam" type="data" format="bam" label="BAM file"> + <validator type="unspecified_build" /> + <validator type="dataset_metadata_in_data_table" table_name="gatk2_picard_indexes" metadata_name="dbkey" metadata_column="dbkey" message="Sequences are not currently available for the specified build." /> <!-- fixme!!! this needs to be a select --> + </param> + </repeat> + <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &lt;reference_sequence&gt;"> + <options from_data_table="gatk2_picard_indexes"> + <!-- <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/> does not yet work in a repeat...--> + </options> + <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/> + </param> + </when> + <when value="history"> <!-- FIX ME!!!! --> + <repeat name="input_bams" title="BAM file" min="1" help="-I,--input_file &lt;input_file&gt;"> + <param name="input_bam" type="data" format="bam" label="BAM file" /> + </repeat> + <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &lt;reference_sequence&gt;" /> + </when> + </conditional> + + <param name="input_calculate_coverage_over_genes" type="data" format="data" label="RefSeq Rod" optional="True" help="-geneList,--calculateCoverageOverGenes &lt;calculateCoverageOverGenes&gt;" /> + + <param name="partition_type" type="select" label="Partition type for depth of coverage" multiple="True" display="checkboxes" help="-pt,--partitionType &lt;partitionType&gt;"> + <option value="sample" selected="True">sample</option> + <option value="readgroup">readgroup</option> + <option value="library">library</option> + </param> + + <repeat name="summary_coverage_threshold_group" title="Summary coverage threshold" help="-ct,--summaryCoverageThreshold &lt;summaryCoverageThreshold&gt;"> + <param name="summary_coverage_threshold" type="integer" value="15" label="for summary file outputs, report the % of bases covered to >= this number" /> + </repeat> + + <param name="output_format" type="select" label="Output format" help="--outputFormat &lt;outputFormat&gt;" > + <option value="csv">csv</option> + <option value="table">table</option> + <option value="rtable" selected="True">rtable</option> + </param> + + <conditional name="gatk_param_type"> + <param name="gatk_param_type_selector" type="select" label="Basic or Advanced GATK options"> + <option value="basic" selected="True">Basic</option> + <option value="advanced">Advanced</option> + </param> + <when value="basic"> + <!-- Do nothing here --> + </when> + <when value="advanced"> + <repeat name="pedigree" title="Pedigree file" help="-ped,--pedigree &lt;pedigree&gt;"> + <param name="pedigree_file" type="data" format="txt" label="Pedigree files for samples"/> + </repeat> + <repeat name="pedigree_string_repeat" title="Pedigree string" help="-pedString,--pedigreeString &lt;pedigreeString&gt;"> + <param name="pedigree_string" type="text" value="" label="Pedigree string for samples"/> + </repeat> + <param name="pedigree_validation_type" type="select" label="How strict should we be in validating the pedigree information" help="-pedValidationType,--pedigreeValidationType &lt;pedigreeValidationType&gt;"> + <option value="STRICT" selected="True">STRICT</option> + <option value="SILENT">SILENT</option> + </param> + <repeat name="read_filter" title="Read Filter" help="-rf,--read_filter &lt;read_filter&gt;"> + <conditional name="read_filter_type"> + <param name="read_filter_type_selector" type="select" label="Read Filter Type"> + <option value="BadCigar">BadCigar</option> + <option value="BadMate">BadMate</option> + <option value="DuplicateRead">DuplicateRead</option> + <option value="FailsVendorQualityCheck">FailsVendorQualityCheck</option> + <option value="MalformedRead">MalformedRead</option> + <option value="MappingQuality">MappingQuality</option> + <option value="MappingQualityUnavailable">MappingQualityUnavailable</option> + <option value="MappingQualityZero">MappingQualityZero</option> + <option value="MateSameStrand">MateSameStrand</option> + <option value="MaxInsertSize">MaxInsertSize</option> + <option value="MaxReadLength" selected="True">MaxReadLength</option> + <option value="MissingReadGroup">MissingReadGroup</option> + <option value="NoOriginalQualityScores">NoOriginalQualityScores</option> + <option value="NotPrimaryAlignment">NotPrimaryAlignment</option> + <option value="Platform454">Platform454</option> + <option value="Platform">Platform</option> + <option value="PlatformUnit">PlatformUnit</option> + <option value="ReadGroupBlackList">ReadGroupBlackList</option> + <option value="ReadName">ReadName</option> + <option value="ReadStrand">ReadStrand</option> + <option value="ReassignMappingQuality">ReassignMappingQuality</option> + <option value="Sample">Sample</option> + <option value="SingleReadGroup">SingleReadGroup</option> + <option value="UnmappedRead">UnmappedRead</option> + </param> + <when value="BadCigar"> + <!-- no extra options --> + </when> + <when value="BadMate"> + <!-- no extra options --> + </when> + <when value="DuplicateRead"> + <!-- no extra options --> + </when> + <when value="FailsVendorQualityCheck"> + <!-- no extra options --> + </when> + <when value="MalformedRead"> + <!-- no extra options --> + </when> + <when value="MappingQuality"> + <param name="min_mapping_quality_score" type="integer" value="10" label="Minimum read mapping quality required to consider a read for calling"/> + </when> + <when value="MappingQualityUnavailable"> + <!-- no extra options --> + </when> + <when value="MappingQualityZero"> + <!-- no extra options --> + </when> + <when value="MateSameStrand"> + <!-- no extra options --> + </when> + <when value="MaxInsertSize"> + <param name="maxInsertSize" type="integer" value="1000000" label="Discard reads with insert size greater than the specified value"/> + </when> + <when value="MaxReadLength"> + <param name="maxReadLength" type="integer" value="76" label="Max Read Length"/> + </when> + <when value="MissingReadGroup"> + <!-- no extra options --> + </when> + <when value="NoOriginalQualityScores"> + <!-- no extra options --> + </when> + <when value="NotPrimaryAlignment"> + <!-- no extra options --> + </when> + <when value="Platform454"> + <!-- no extra options --> + </when> + <when value="Platform"> + <param name="PLFilterName" type="text" value="" label="Discard reads with RG:PL attribute containing this string"/> + </when> + <when value="PlatformUnit"> + <!-- no extra options --> + </when> + <when value="ReadGroupBlackList"> + <!-- no extra options --> + </when> + <when value="ReadName"> + <param name="readName" type="text" value="" label="Filter out all reads except those with this read name"/> + </when> + <when value="ReadStrand"> + <param name="filterPositive" type="boolean" truevalue="--filterPositive" falsevalue="" label="Discard reads on the forward strand"/> + </when> + <when value="ReassignMappingQuality"> + <param name="default_mapping_quality" type="integer" value="60" label="Default read mapping quality to assign to all reads"/> + </when> + <when value="Sample"> + <param name="sample_to_keep" type="text" value="" label="The name of the sample(s) to keep, filtering out all others"/> + </when> + <when value="SingleReadGroup"> + <param name="read_group_to_keep" type="integer" value="76" label="The name of the read group to keep, filtering out all others"/> + </when> + <when value="UnmappedRead"> + <!-- no extra options --> + </when> + </conditional> + </repeat> + <repeat name="input_interval_repeat" title="Operate on Genomic intervals" help="-L,--intervals &lt;intervals&gt;"> + <param name="input_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" /> + </repeat> + <repeat name="input_exclude_interval_repeat" title="Exclude Genomic intervals" help="-XL,--excludeIntervals &lt;excludeIntervals&gt;"> + <param name="input_exclude_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" /> + </repeat> + + <param name="interval_set_rule" type="select" label="Interval set rule" help="-isr,--interval_set_rule &lt;interval_set_rule&gt;"> + <option value="UNION" selected="True">UNION</option> + <option value="INTERSECTION">INTERSECTION</option> + </param> + + <conditional name="downsampling_type"> + <param name="downsampling_type_selector" type="select" label="Type of reads downsampling to employ at a given locus" help="-dt,--downsampling_type &lt;downsampling_type&gt;"> + <option value="NONE" selected="True">NONE</option> + <option value="ALL_READS">ALL_READS</option> + <option value="BY_SAMPLE">BY_SAMPLE</option> + </param> + <when value="NONE"> + <!-- no more options here --> + </when> + <when value="ALL_READS"> + <conditional name="downsample_to_type"> + <param name="downsample_to_type_selector" type="select" label="Downsample method"> + <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option> + <option value="downsample_to_coverage">Downsample by Coverage</option> + </param> + <when value="downsample_to_fraction"> + <param name="downsample_to_value" type="float" label="Fraction [0.0-1.0] of reads to downsample to" value="1" min="0" max="1" help="-dfrac,--downsample_to_fraction &lt;downsample_to_fraction&gt;"/> + </when> + <when value="downsample_to_coverage"> + <param name="downsample_to_value" type="integer" label="Coverage to downsample to at any given locus" value="0" help="-dcov,--downsample_to_coverage &lt;downsample_to_coverage&gt;"/> + </when> + </conditional> + </when> + <when value="BY_SAMPLE"> + <conditional name="downsample_to_type"> + <param name="downsample_to_type_selector" type="select" label="Downsample method"> + <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option> + <option value="downsample_to_coverage">Downsample by Coverage</option> + </param> + <when value="downsample_to_fraction"> + <param name="downsample_to_value" type="float" label="Fraction [0.0-1.0] of reads to downsample to" value="1" min="0" max="1" help="-dfrac,--downsample_to_fraction &lt;downsample_to_fraction&gt;"/> + </when> + <when value="downsample_to_coverage"> + <param name="downsample_to_value" type="integer" label="Coverage to downsample to at any given locus" value="0" help="-dcov,--downsample_to_coverage &lt;downsample_to_coverage&gt;"/> + </when> + </conditional> + </when> + </conditional> + <param name="baq" type="select" label="Type of BAQ calculation to apply in the engine" help="-baq,--baq &lt;baq&gt;"> + <option value="OFF" selected="True">OFF</option> + <option value="CALCULATE_AS_NECESSARY">CALCULATE_AS_NECESSARY</option> + <option value="RECALCULATE">RECALCULATE</option> + </param> + <param name="baq_gap_open_penalty" type="float" label="BAQ gap open penalty (Phred Scaled)" value="40" help="Default value is 40. 30 is perhaps better for whole genome call sets. -baqGOP,--baqGapOpenPenalty &lt;baqGapOpenPenalty&gt;" /> + <param name="use_original_qualities" type="boolean" truevalue="--useOriginalQualities" falsevalue="" label="Use the original base quality scores from the OQ tag" help="-OQ,--useOriginalQualities" /> + <param name="default_base_qualities" type="integer" label="Value to be used for all base quality scores, when some are missing" value="-1" help="-DBQ,--defaultBaseQualities &lt;defaultBaseQualities&gt;"/> + <param name="validation_strictness" type="select" label="How strict should we be with validation" help="-S,--validation_strictness &lt;validation_strictness&gt;"> + <option value="STRICT" selected="True">STRICT</option> + <option value="LENIENT">LENIENT</option> + <option value="SILENT">SILENT</option> + <!-- <option value="DEFAULT_STRINGENCY">DEFAULT_STRINGENCY</option> listed in docs, but not valid value...--> + </param> + <param name="interval_merging" type="select" label="Interval merging rule" help="-im,--interval_merging &lt;interval_merging&gt;"> + <option value="ALL" selected="True">ALL</option> + <option value="OVERLAPPING_ONLY">OVERLAPPING_ONLY</option> + </param> + + <repeat name="read_group_black_list_repeat" title="Read group black list" help="-rgbl,--read_group_black_list &lt;read_group_black_list&gt;"> + <conditional name="read_group_black_list_type"> + <param name="read_group_black_list_type_selector" type="select" label="Type of reads read group black list"> + <option value="file" selected="True">Filters in file</option> + <option value="text">Specify filters as a string</option> + </param> + <when value="file"> + <param name="read_group_black_list" type="data" format="txt" label="Read group black list file" /> + </when> + <when value="text"> + <param name="read_group_black_list" type="text" value="tag:string" label="Read group black list tag:string" /> + </when> + </conditional> + </repeat> + + <param name="disable_experimental_low_memory_sharding" type="boolean" truevalue="--disable_experimental_low_memory_sharding" falsevalue="" label="Disable experimental low-memory sharding functionality." checked="False" help="--disable_experimental_low_memory_sharding"/> + <param name="non_deterministic_random_seed" type="boolean" truevalue="--nonDeterministicRandomSeed" falsevalue="" label="Makes the GATK behave non deterministically, that is, the random numbers generated will be different in every run" checked="False" help="-ndrs,--nonDeterministicRandomSeed"/> + + </when> + </conditional> + + <conditional name="analysis_param_type"> + <param name="analysis_param_type_selector" type="select" label="Basic or Advanced Analysis options"> + <option value="basic" selected="True">Basic</option> + <option value="advanced">Advanced</option> + </param> + <when value="basic"> + <!-- Do nothing here --> + </when> + <when value="advanced"> + <param name="ignore_deletion_sites" type="boolean" truevalue="--ignoreDeletionSites" falsevalue="" checked="False" label="Ignore sites consisting only of deletions" help="--ignoreDeletionSites" /> + <param name="include_deletions" type="boolean" truevalue="--includeDeletions" falsevalue="" checked="False" label="Include information on deletions" help="-dels,--includeDeletions" /> + <param name="max_base_quality" type="integer" value="127" label="Maximum quality of bases to count towards depth" help="--maxBaseQuality &lt;maxBaseQuality&gt;" /> + <param name="min_base_quality" type="integer" value="-1" label="Minimum quality of bases to count towards depth" help="-mbq,--minBaseQuality &lt;minBaseQuality&gt;" /> + <param name="max_mapping_quality" type="integer" value="2147483647" label="Maximum mapping quality of reads to count towards depth." help="--maxMappingQuality &lt;maxMappingQuality&gt;" /> + <param name="min_mapping_quality" type="integer" value="127" label="Minimum mapping quality of reads to count towards depth" help="-mmq,--minMappingQuality &lt;minMappingQuality&gt;" /> + <param name="n_bins" type="integer" value="499" label="Number of bins to use for granular binning" help="--nBins &lt;nBins&gt;" /> + <param name="omit_depth_output_at_each_base" type="boolean" truevalue="--omitDepthOutputAtEachBase" falsevalue="" checked="False" label="Omit the output of the depth of coverage at each base" help="-omitBaseOutput,--omitDepthOutputAtEachBase" /> + <param name="omit_interval_statistics" type="boolean" truevalue="--omitIntervalStatistics" falsevalue="" checked="False" label="Omit the per-interval statistics section" help="-omitIntervals,--omitIntervalStatistics" /> + <param name="omit_locus_table" type="boolean" truevalue="--omitLocusTable" falsevalue="" checked="False" label="Do not calculate the per-sample per-depth counts of loci" help="-omitLocusTable,--omitLocusTable" /> + <param name="omit_per_sample_stats" type="boolean" truevalue="--omitPerSampleStats" falsevalue="" checked="False" label="Omit the summary files per-sample." help="-omitSampleSummary,--omitPerSampleStats" /> + <param name="print_base_counts" type="boolean" truevalue="--printBaseCounts" falsevalue="" checked="False" label="Add base counts to per-locus output" help="-baseCounts,--printBaseCounts" /> + <param name="print_bin_endpoints_and_exit" type="boolean" truevalue="--printBinEndpointsAndExit" falsevalue="" checked="False" label="Print the bin values and exits immediately" help="--printBinEndpointsAndExit" /> + <param name="start" type="integer" value="1" label="Starting (left endpoint) for granular binning" help="--start &lt;start&gt;" /> + <param name="stop" type="integer" value="500" label="Ending (right endpoint) for granular binning" help="--stop &lt;stop&gt;" /> + </when> + </conditional> + </inputs> + <outputs> + <data format="tabular" name="output_per_locus_coverage" label="${tool.name} on ${on_string} (per locus coverage)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_summary_sample" label="${tool.name} on ${on_string} (output summary sample)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'sample' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_statistics_sample" label="${tool.name} on ${on_string} (output statistics sample)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'sample' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_interval_summary_sample" label="${tool.name} on ${on_string} (output interval summary sample)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'sample' in partition_type or not partition_type</filter> + <filter>gatk_param_type['gatk_param_type_selector'] == "advanced" and len( gatk_param_type['input_interval_repeat'] )</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_interval_statistics'] == False</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_interval_statistics_sample" label="${tool.name} on ${on_string} (output interval statistics sample)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'sample' in partition_type or not partition_type</filter> + <filter>gatk_param_type['gatk_param_type_selector'] == "advanced" and len( gatk_param_type['input_interval_repeat'] )</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_interval_statistics'] == False</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_gene_summary_sample" label="${tool.name} on ${on_string} (output gene summary sample)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>input_calculate_coverage_over_genes is not None and 'sample' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_gene_statistics_sample" label="${tool.name} on ${on_string} (output gene statistics sample)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>input_calculate_coverage_over_genes is not None and 'sample' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_cumulative_coverage_counts_sample" label="${tool.name} on ${on_string} (output cumulative coverage counts sample)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_depth_output_at_each_base'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'sample' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_cumulative_coverage_proportions_sample" label="${tool.name} on ${on_string} (output cumulative coverage proportions sample)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_depth_output_at_each_base'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'sample' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + + <data format="tabular" name="output_summary_readgroup" label="${tool.name} on ${on_string} (output summary readgroup)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'readgroup' in partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_statistics_readgroup" label="${tool.name} on ${on_string} (output statistics readgroup)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'readgroup' in partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_interval_summary_readgroup" label="${tool.name} on ${on_string} (output interval summary readgroup)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'readgroup' in partition_type</filter> + <filter>gatk_param_type['gatk_param_type_selector'] == "advanced" and len( gatk_param_type['input_interval_repeat'] )</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_interval_statistics'] == False</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_interval_statistics_readgroup" label="${tool.name} on ${on_string} (output interval statistics readgroup)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'readgroup' in partition_type</filter> + <filter>gatk_param_type['gatk_param_type_selector'] == "advanced" and len( gatk_param_type['input_interval_repeat'] )</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_interval_statistics'] == False</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_gene_summary_readgroup" label="${tool.name} on ${on_string} (output gene summary readgroup)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>input_calculate_coverage_over_genes is not None and 'readgroup' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_gene_statistics_readgroup" label="${tool.name} on ${on_string} (output gene statistics readgroup)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>input_calculate_coverage_over_genes is not None and 'readgroup' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_cumulative_coverage_counts_readgroup" label="${tool.name} on ${on_string} (output cumulative coverage counts readgroup)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_depth_output_at_each_base'] == False</filter> + <filter>'readgroup' in partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_cumulative_coverage_proportions_readgroup" label="${tool.name} on ${on_string} (output cumulative coverage proportions readgroup)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_depth_output_at_each_base'] == False</filter> + <filter>'readgroup' in partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + + <data format="tabular" name="output_summary_library" label="${tool.name} on ${on_string} (output summary library)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'library' in partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_statistics_library" label="${tool.name} on ${on_string} (output statistics library)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'library' in partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_interval_summary_library" label="${tool.name} on ${on_string} (output interval summary library)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'library' in partition_type</filter> + <filter>gatk_param_type['gatk_param_type_selector'] == "advanced" and len( gatk_param_type['input_interval_repeat'] )</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_interval_statistics'] == False</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_interval_statistics_library" label="${tool.name} on ${on_string} (output interval statistics library)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'library' in partition_type</filter> + <filter>gatk_param_type['gatk_param_type_selector'] == "advanced" and len( gatk_param_type['input_interval_repeat'] )</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_interval_statistics'] == False</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_gene_summary_library" label="${tool.name} on ${on_string} (output gene summary library)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>input_calculate_coverage_over_genes is not None and 'library' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_gene_statistics_library" label="${tool.name} on ${on_string} (output gene statistics library)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>input_calculate_coverage_over_genes is not None and 'library' in partition_type or not partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_cumulative_coverage_counts_library" label="${tool.name} on ${on_string} (output cumulative coverage counts library)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_depth_output_at_each_base'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'library' in partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + <data format="tabular" name="output_cumulative_coverage_proportions_library" label="${tool.name} on ${on_string} (output cumulative coverage proportions library)" > + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_depth_output_at_each_base'] == False</filter> + <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> + <filter>'library' in partition_type</filter> + <actions> + <conditional name="output_format"> + <when value="rtable"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + <when value="csv"> + <action type="format"> + <option type="from_param" name="output_format" /> + </action> + </when> + </conditional> + </actions> + </data> + + <data format="tabular" name="output_log" label="${tool.name} on ${on_string} (log)" /> + </outputs> + <trackster_conf/> + <tests> + <test> + <param name="reference_source_selector" value="history" /> + <param name="ref_file" value="phiX.fasta" ftype="fasta" /> + <param name="input_bam" value="gatk/gatk_table_recalibration/gatk_table_recalibration_out_1.bam" ftype="bam" /> + <param name="input_calculate_coverage_over_genes" /> + <param name="partition_type" value="sample" /> + <param name="summary_coverage_threshold_group" value="0" /> + <param name="output_format" value="rtable" /> + <param name="gatk_param_type_selector" value="basic" /> + <param name="analysis_param_type_selector" value="basic" /> + <output name="output_per_locus_coverage" file="gatk/gatk_depth_of_coverage/gatk_depth_of_coverage_out_1_output_per_locus_coverage.tabular" /> + <output name="output_summary_sample" file="gatk/gatk_depth_of_coverage/gatk_depth_of_coverage_out_1_output_summary_sample.tabular" /> + <output name="output_statistics_sample" file="gatk/gatk_depth_of_coverage/gatk_depth_of_coverage_out_1_output_statistics_sample.tabular" /> + <output name="output_cumulative_coverage_counts_sample" file="gatk/gatk_depth_of_coverage/gatk_depth_of_coverage_out_1_output_cumulative_coverage_counts_sample.tabular" /> + <output name="output_cumulative_coverage_proportions_sample" file="gatk/gatk_depth_of_coverage/gatk_depth_of_coverage_out_1_output_output_cumulative_coverage_proportions_sample.tabular" /> + <output name="output_log" file="gatk/gatk_depth_of_coverage/gatk_depth_of_coverage_out_1.log.contains" compare="contains" /> + </test> + </tests> + <help> +**What it does** + +DepthOfCoverage processes a set of bam files to determine coverage at different levels of partitioning and aggregation. Coverage can be analyzed per locus, per interval, per gene, or in total; can be partitioned by sample, by read group, by technology, by center, or by library; and can be summarized by mean, median, quartiles, and/or percentage of bases covered to or beyond a threshold. Additionally, reads and bases can be filtered by mapping or base quality score. + +For more information on the GATK Depth of Coverage, see this `tool specific page <http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_annotator_DepthOfCoverage.html>`_. + +To learn about best practices for variant detection using GATK, see this `overview <http://www.broadinstitute.org/gatk/guide/topic?name=best-practices>`_. + +If you encounter errors, please view the `GATK FAQ <http://www.broadinstitute.org/gatk/guide/topic?name=faqs>`_. + +------ + +**Inputs** + +GenomeAnalysisTK: DepthOfCoverage accepts aligned BAM input files. + + +**Outputs** + +The output is in various table formats. + + +Go `here <http://www.broadinstitute.org/gatk/guide/topic?name=intro>`_ for details on GATK file formats. + +------- + +**Settings**:: + + calculateCoverageOverGenes File NA Calculate the coverage statistics over this list of genes. Currently accepts RefSeq. + ignoreDeletionSites boolean false Ignore sites consisting only of deletions + includeDeletions boolean false Include information on deletions + maxBaseQuality byte 127 Maximum quality of bases to count towards depth. Defaults to 127 (Byte.MAX_VALUE). + maxMappingQuality int 2147483647 Maximum mapping quality of reads to count towards depth. Defaults to 2^31-1 (Integer.MAX_VALUE). + minBaseQuality byte -1 Minimum quality of bases to count towards depth. Defaults to -1. + minMappingQuality int -1 Minimum mapping quality of reads to count towards depth. Defaults to -1. + nBins int 499 Number of bins to use for granular binning + omitDepthOutputAtEachBase boolean false Will omit the output of the depth of coverage at each base, which should result in speedup + omitIntervalStatistics boolean false Will omit the per-interval statistics section, which should result in speedup + omitLocusTable boolean false Will not calculate the per-sample per-depth counts of loci, which should result in speedup + omitPerSampleStats boolean false Omits the summary files per-sample. These statistics are still calculated, so this argument will not improve runtime. + outputFormat String rtable the format of the output file (e.g. csv, table, rtable); defaults to r-readable table + partitionType Set[Partition] [sample] Partition type for depth of coverage. Defaults to sample. Can be any combination of sample, readgroup, library. + printBaseCounts boolean false Will add base counts to per-locus output. + printBinEndpointsAndExit boolean false Prints the bin values and exits immediately. Use to calibrate what bins you want before running on data. + start int 1 Starting (left endpoint) for granular binning + stop int 500 Ending (right endpoint) for granular binning + summaryCoverageThreshold int[] [15] for summary file outputs, report the % of bases coverd to >= this number. Defaults to 15; can take multiple arguments. + +------ + +**Citation** + +For the underlying tool, please cite `DePristo MA, Banks E, Poplin R, Garimella KV, Maguire JR, Hartl C, Philippakis AA, del Angel G, Rivas MA, Hanna M, McKenna A, Fennell TJ, Kernytsky AM, Sivachenko AY, Cibulskis K, Gabriel SB, Altshuler D, Daly MJ. A framework for variation discovery and genotyping using next-generation DNA sequencing data. Nat Genet. 2011 May;43(5):491-8. <http://www.ncbi.nlm.nih.gov/pubmed/21478889>`_ + +Please also site `McKenna A, Hanna M, Banks E, Sivachenko A, Cibulskis K, Kernytsky A, Garimella K, Altshuler D, Gabriel S, Daly M, DePristo MA (2010). The Genome Analysis Toolkit: a MapReduce framework for analyzing next-generation DNA sequencing data. Genome Res. 20:1297-303. Epub 2010 Jul 19. <http://www.ncbi.nlm.nih.gov/pubmed/20644199>`_ + +If you use this tool in Galaxy, please cite `Blankenberg D, Von Kuster G, Coraor N, Ananda G, Lazarus R, Mangan M, Nekrutenko A, Taylor J. Galaxy: a web-based genome analysis tool for experimentalists. Curr Protoc Mol Biol. 2010 Jan;Chapter 19:Unit 19.10.1-21. <http://www.ncbi.nlm.nih.gov/pubmed/20069535>`_ + + </help> +</tool>