comparison depth_of_coverage.xml @ 11:0d369d08ad6e draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit 344140b8df53b8b7024618bb04594607a045c03a
author iuc
date Mon, 04 May 2015 22:47:06 -0400
parents b80301676614
children 669a23f1f4b5
comparison
equal deleted inserted replaced
10:5db8d6815cf3 11:0d369d08ad6e
1 <tool id="gatk2_depth_of_coverage" name="Depth of Coverage" version="@VERSION@.0"> 1 <tool id="gatk2_depth_of_coverage" name="Depth of Coverage" version="@VERSION@.0">
2 <description>on BAM files</description> 2 <description>on BAM files</description>
3 <expand macro="requirements" />
4 <expand macro="version_command" />
5 <macros> 3 <macros>
6 <import>gatk2_macros.xml</import> 4 <import>gatk2_macros.xml</import>
7 </macros> 5 </macros>
6 <expand macro="requirements" />
7 <expand macro="version_command" />
8 <command interpreter="python">gatk2_wrapper.py 8 <command interpreter="python">gatk2_wrapper.py
9 ##--max_jvm_heap_fraction "1" 9 ##--max_jvm_heap_fraction "1"
10 --stdout "${output_log}" 10 --stdout "${output_log}"
11 #for $i, $input_bam in enumerate( $reference_source.input_bams ): 11 #for $i, $input_bam in enumerate( $reference_source.input_bams ):
12 -d "-I" "${input_bam.input_bam}" "${input_bam.input_bam.ext}" "gatk_input_${i}" 12 -d "-I" "${input_bam.input_bam}" "${input_bam.input_bam.ext}" "gatk_input_${i}"
31 #for $pt in str( $partition_type ).split( ',' ): 31 #for $pt in str( $partition_type ).split( ',' ):
32 --partitionType "${pt}" 32 --partitionType "${pt}"
33 #end for 33 #end for
34 #end if 34 #end if
35 --out "${output_per_locus_coverage}" 35 --out "${output_per_locus_coverage}"
36 36
37 #for $ct_group in $summary_coverage_threshold_group: 37 #for $ct_group in $summary_coverage_threshold_group:
38 --summaryCoverageThreshold "${ct_group.summary_coverage_threshold}" 38 --summaryCoverageThreshold "${ct_group.summary_coverage_threshold}"
39 #end for 39 #end for
40 --outputFormat "${output_format}" 40 --outputFormat "${output_format}"
41 ' 41 '
42 42
43 #include source=$standard_gatk_options# 43 #include source=$standard_gatk_options#
44 ##start analysis specific options 44 ##start analysis specific options
45 #if $analysis_param_type.analysis_param_type_selector == "advanced": 45 #if $analysis_param_type.analysis_param_type_selector == "advanced":
46 -p ' 46 -p '
47 ${analysis_param_type.ignore_deletion_sites} 47 ${analysis_param_type.ignore_deletion_sites}
83 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "": 83 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "":
84 &amp;&amp; mv ${output_per_locus_coverage}.sample_cumulative_coverage_counts ${output_cumulative_coverage_counts_sample} 84 &amp;&amp; mv ${output_per_locus_coverage}.sample_cumulative_coverage_counts ${output_cumulative_coverage_counts_sample}
85 &amp;&amp; mv ${output_per_locus_coverage}.sample_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_sample} 85 &amp;&amp; mv ${output_per_locus_coverage}.sample_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_sample}
86 #end if 86 #end if
87 #end if 87 #end if
88 88
89 #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 ) == "" ): 89 #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 ) == "" ):
90 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_per_sample_stats ) == "": 90 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_per_sample_stats ) == "":
91 &amp;&amp; mv ${output_per_locus_coverage}.read_group_summary ${output_summary_readgroup} 91 &amp;&amp; mv ${output_per_locus_coverage}.read_group_summary ${output_summary_readgroup}
92 &amp;&amp; mv ${output_per_locus_coverage}.read_group_statistics ${output_statistics_readgroup} 92 &amp;&amp; mv ${output_per_locus_coverage}.read_group_statistics ${output_statistics_readgroup}
93 #end if 93 #end if
102 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "": 102 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "":
103 &amp;&amp; mv ${output_per_locus_coverage}.read_group_cumulative_coverage_counts ${output_cumulative_coverage_counts_readgroup} 103 &amp;&amp; mv ${output_per_locus_coverage}.read_group_cumulative_coverage_counts ${output_cumulative_coverage_counts_readgroup}
104 &amp;&amp; mv ${output_per_locus_coverage}.read_group_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_readgroup} 104 &amp;&amp; mv ${output_per_locus_coverage}.read_group_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_readgroup}
105 #end if 105 #end if
106 #end if 106 #end if
107 107
108 #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 ) == "" ): 108 #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 ) == "" ):
109 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_per_sample_stats ) == "": 109 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_per_sample_stats ) == "":
110 &amp;&amp; mv ${output_per_locus_coverage}.library_summary ${output_summary_library} 110 &amp;&amp; mv ${output_per_locus_coverage}.library_summary ${output_summary_library}
111 &amp;&amp; mv ${output_per_locus_coverage}.library_statistics ${output_statistics_library} 111 &amp;&amp; mv ${output_per_locus_coverage}.library_statistics ${output_statistics_library}
112 #end if 112 #end if
121 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "": 121 #if str( $analysis_param_type.analysis_param_type_selector ) == "basic" or str( $analysis_param_type.omit_depth_output_at_each_base ) == "":
122 &amp;&amp; mv ${output_per_locus_coverage}.library_cumulative_coverage_counts ${output_cumulative_coverage_counts_library} 122 &amp;&amp; mv ${output_per_locus_coverage}.library_cumulative_coverage_counts ${output_cumulative_coverage_counts_library}
123 &amp;&amp; mv ${output_per_locus_coverage}.library_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_library} 123 &amp;&amp; mv ${output_per_locus_coverage}.library_cumulative_coverage_proportions ${output_cumulative_coverage_proportions_library}
124 #end if 124 #end if
125 #end if 125 #end if
126
127 126
128 </command> 127 </command>
129 <inputs> 128 <inputs>
130 <conditional name="reference_source"> 129 <conditional name="reference_source">
131 <expand macro="reference_source_selector_param" /> 130 <expand macro="reference_source_selector_param" />
136 <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 --> 135 <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 -->
137 </param> 136 </param>
138 </repeat> 137 </repeat>
139 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;"> 138 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
140 <options from_data_table="gatk2_picard_indexes"> 139 <options from_data_table="gatk2_picard_indexes">
141 <!-- <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/> does not yet work in a repeat...--> 140 <!-- <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/> does not yet work in a repeat...-->
142 </options> 141 </options>
143 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/> 142 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
144 </param> 143 </param>
145 </when> 144 </when>
146 <when value="history"> <!-- FIX ME!!!! --> 145 <when value="history"> <!-- FIX ME!!!! -->
148 <param name="input_bam" type="data" format="bam" label="BAM file" /> 147 <param name="input_bam" type="data" format="bam" label="BAM file" />
149 </repeat> 148 </repeat>
150 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" /> 149 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" />
151 </when> 150 </when>
152 </conditional> 151 </conditional>
153 152
154 <param name="input_calculate_coverage_over_genes" type="data" format="data" label="RefSeq Rod" optional="True" help="-geneList,--calculateCoverageOverGenes &amp;lt;calculateCoverageOverGenes&amp;gt;" /> 153 <param name="input_calculate_coverage_over_genes" type="data" format="data" label="RefSeq Rod" optional="True" help="-geneList,--calculateCoverageOverGenes &amp;lt;calculateCoverageOverGenes&amp;gt;" />
155 154
156 <param name="partition_type" type="select" label="Partition type for depth of coverage" multiple="True" display="checkboxes" help="-pt,--partitionType &amp;lt;partitionType&amp;gt;"> 155 <param name="partition_type" type="select" label="Partition type for depth of coverage" multiple="True" display="checkboxes" help="-pt,--partitionType &amp;lt;partitionType&amp;gt;">
157 <option value="sample" selected="True">sample</option> 156 <option value="sample" selected="True">sample</option>
158 <option value="readgroup">readgroup</option> 157 <option value="readgroup">readgroup</option>
159 <option value="library">library</option> 158 <option value="library">library</option>
160 </param> 159 </param>
161 160
162 <repeat name="summary_coverage_threshold_group" title="Summary coverage threshold" help="-ct,--summaryCoverageThreshold &amp;lt;summaryCoverageThreshold&amp;gt;"> 161 <repeat name="summary_coverage_threshold_group" title="Summary coverage threshold" help="-ct,--summaryCoverageThreshold &amp;lt;summaryCoverageThreshold&amp;gt;">
163 <param name="summary_coverage_threshold" type="integer" value="15" label="for summary file outputs, report the % of bases covered to &gt;= this number" /> 162 <param name="summary_coverage_threshold" type="integer" value="15" label="for summary file outputs, report the % of bases covered to &gt;= this number" />
164 </repeat> 163 </repeat>
165 164
166 <param name="output_format" type="select" label="Output format" help="--outputFormat &amp;lt;outputFormat&amp;gt;" > 165 <param name="output_format" type="select" label="Output format" help="--outputFormat &amp;lt;outputFormat&amp;gt;" >
167 <option value="csv">csv</option> 166 <option value="csv">csv</option>
168 <option value="table">table</option> 167 <option value="table">table</option>
169 <option value="rtable" selected="True">rtable</option> 168 <option value="rtable" selected="True">rtable</option>
170 </param> 169 </param>
171 170
172 <expand macro="gatk_param_type_conditional" /> 171 <expand macro="gatk_param_type_conditional" />
173 172
174 <expand macro="analysis_type_conditional"> 173 <expand macro="analysis_type_conditional">
175 <param name="ignore_deletion_sites" type="boolean" truevalue="--ignoreDeletionSites" falsevalue="" checked="False" label="Ignore sites consisting only of deletions" help="--ignoreDeletionSites" /> 174 <param name="ignore_deletion_sites" type="boolean" truevalue="--ignoreDeletionSites" falsevalue="" checked="False" label="Ignore sites consisting only of deletions" help="--ignoreDeletionSites" />
176 <param name="include_deletions" type="boolean" truevalue="--includeDeletions" falsevalue="" checked="False" label="Include information on deletions" help="-dels,--includeDeletions" /> 175 <param name="include_deletions" type="boolean" truevalue="--includeDeletions" falsevalue="" checked="False" label="Include information on deletions" help="-dels,--includeDeletions" />
177 <param name="max_base_quality" type="integer" value="127" label="Maximum quality of bases to count towards depth" help="--maxBaseQuality &amp;lt;maxBaseQuality&amp;gt;" /> 176 <param name="max_base_quality" type="integer" value="127" label="Maximum quality of bases to count towards depth" help="--maxBaseQuality &amp;lt;maxBaseQuality&amp;gt;" />
178 <param name="min_base_quality" type="integer" value="-1" label="Minimum quality of bases to count towards depth" help="-mbq,--minBaseQuality &amp;lt;minBaseQuality&amp;gt;" /> 177 <param name="min_base_quality" type="integer" value="-1" label="Minimum quality of bases to count towards depth" help="-mbq,--minBaseQuality &amp;lt;minBaseQuality&amp;gt;" />
357 </action> 356 </action>
358 </when> 357 </when>
359 </conditional> 358 </conditional>
360 </actions> 359 </actions>
361 </data> 360 </data>
362 361
363 <data format="tabular" name="output_summary_readgroup" label="${tool.name} on ${on_string} (output summary readgroup)" > 362 <data format="tabular" name="output_summary_readgroup" label="${tool.name} on ${on_string} (output summary readgroup)" >
364 <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter> 363 <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter>
365 <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> 364 <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter>
366 <filter>'readgroup' in partition_type</filter> 365 <filter>'readgroup' in partition_type</filter>
367 <actions> 366 <actions>
510 </action> 509 </action>
511 </when> 510 </when>
512 </conditional> 511 </conditional>
513 </actions> 512 </actions>
514 </data> 513 </data>
515 514
516 <data format="tabular" name="output_summary_library" label="${tool.name} on ${on_string} (output summary library)" > 515 <data format="tabular" name="output_summary_library" label="${tool.name} on ${on_string} (output summary library)" >
517 <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter> 516 <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['omit_per_sample_stats'] == False</filter>
518 <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter> 517 <filter>analysis_param_type['analysis_param_type_selector'] == "basic" or analysis_param_type['print_bin_endpoints_and_exit'] == False</filter>
519 <filter>'library' in partition_type</filter> 518 <filter>'library' in partition_type</filter>
520 <actions> 519 <actions>
663 </action> 662 </action>
664 </when> 663 </when>
665 </conditional> 664 </conditional>
666 </actions> 665 </actions>
667 </data> 666 </data>
668 667
669 <data format="tabular" name="output_log" label="${tool.name} on ${on_string} (log)" /> 668 <data format="tabular" name="output_log" label="${tool.name} on ${on_string} (log)" />
670 </outputs> 669 </outputs>
671 <trackster_conf/> 670 <trackster_conf/>
672 <tests> 671 <tests>
673 <test> 672 <test>
689 </test> 688 </test>
690 </tests> 689 </tests>
691 <help> 690 <help>
692 **What it does** 691 **What it does**
693 692
694 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. 693 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.
695 694
696 For more information on the GATK Depth of Coverage, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_coverage_DepthOfCoverage.html&gt;`_. 695 For more information on the GATK Depth of Coverage, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_coverage_DepthOfCoverage.html&gt;`_.
697 696
698 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gatk/guide/topic?name=best-practices&gt;`_. 697 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gatk/guide/topic?name=best-practices&gt;`_.
699 698