annotate print_reads.xml @ 0:e768f4851646 draft

Imported from capsule None
author devteam
date Tue, 01 Apr 2014 10:48:38 -0400
parents
children a8b94864fe35
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="gatk_print_reads" name="Print Reads" version="0.0.1">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
2 <description>from BAM files</description>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.4">gatk</requirement>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="0.1.18">samtools</requirement>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
6 </requirements>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
7 <macros>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
8 <import>gatk_macros.xml</import>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
9 </macros>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
10 <command interpreter="python">gatk_wrapper.py
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
11 --max_jvm_heap_fraction "1"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
12 --stdout "${output_log}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
13 #for $i, $input_bam in enumerate( $reference_source.input_bams ):
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
14 -d "-I" "${input_bam.input_bam}" "${input_bam.input_bam.ext}" "gatk_input_${i}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
15 #if str( $input_bam.input_bam.metadata.bam_index ) != "None":
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
16 -d "" "${input_bam.input_bam.metadata.bam_index}" "bam_index" "gatk_input_${i}" ##hardcode galaxy ext type as bam_index
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
17 #end if
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
18 #end for
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
19 -p 'java
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
20 -jar "\$JAVA_JAR_PATH/GenomeAnalysisTK.jar"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
21 -T "PrintReads"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
22 ##--num_threads 4 ##hard coded, for now
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
23 --out "${output_bam}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
24 -et "NO_ET" ##ET no phone home
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
25 #if $reference_source.reference_source_selector != "history":
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
26 -R "${reference_source.ref_file.fields.path}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
27 #end if
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
28 --number "${number}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
29 #if $platform:
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
30 --platform "${platform}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
31 #end if
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
32 #if $read_group:
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
33 --readGroup "${read_group}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
34 #end if
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
35 #for $sample_file in $sample_file_repeat:
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
36 --sample_file "${sample_file.input_sample_file}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
37 #end for
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
38 #for $sample_name in $sample_name_repeat:
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
39 --sample_name "${sample_name.sample_name}"
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
40 #end for
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
41 '
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
42
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
43 #include source=$standard_gatk_options#
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
44
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
45 </command>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
46 <inputs>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
47 <conditional name="reference_source">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
48 <expand macro="reference_source_selector_param" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
49 <when value="cached">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
50 <repeat name="input_bams" title="BAM file" min="1" help="-I,--input_file &amp;lt;input_file&amp;gt;">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
51 <param name="input_bam" type="data" format="bam" label="BAM file">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
52 <validator type="unspecified_build" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
53 <validator type="dataset_metadata_in_data_table" table_name="gatk_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 -->
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
54 </param>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
55 </repeat>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
56 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
57 <options from_data_table="gatk_picard_indexes">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
58 <!-- <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/> does not yet work in a repeat...-->
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
59 </options>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
60 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
61 </param>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
62 </when>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
63 <when value="history"> <!-- FIX ME!!!! -->
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
64 <repeat name="input_bams" title="BAM file" min="1" help="-I,--input_file &amp;lt;input_file&amp;gt;">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
65 <param name="input_bam" type="data" format="bam" label="BAM file" >
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
66 </param>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
67 </repeat>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
68 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
69 </when>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
70 </conditional>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
71
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
72 <param name="number" type="integer" value="-1" label="Print the first n reads from the file, discarding the rest" help="-n,--number &amp;lt;number&amp;gt;" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
73 <param name="platform" type="text" value="" label="Exclude all reads with this platform from the output" help="-platform,--platform &amp;lt;platform&amp;gt;" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
74 <param name="read_group" type="text" value="" label="Exclude all reads with this read group from the output" help="-readGroup,--readGroup &amp;lt;readGroup&amp;gt;" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
75 <repeat name="sample_file_repeat" title="File containing a list of samples to include" help="-sf,--sample_file &amp;lt;sample_file&amp;gt;">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
76 <param name="input_sample_file" type="data" format="text" label="Sample file" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
77 </repeat>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
78 <repeat name="sample_name_repeat" title="Sample name to be included in the analysis" help="-sn,--sample_name &amp;lt;sample_name&amp;gt;">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
79 <param name="sample_name" type="text" label="Sample name" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
80 </repeat>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
81
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
82 <expand macro="gatk_param_type_conditional" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
83
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
84 </inputs>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
85 <outputs>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
86 <data format="bam" name="output_bam" label="${tool.name} on ${on_string} (BAM)" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
87 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
88 </outputs>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
89 <param name="number" type="integer" value="-1" label="Print the first n reads from the file, discarding the rest" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
90 <param name="platform" type="text" value="" label="Exclude all reads with this platform from the output" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
91 <param name="read_group" type="text" value="" label="Exclude all reads with this read group from the output" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
92 <repeat name="sample_file_repeat" title="File containing a list of samples to include">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
93 <param name="input_sample_file" type="data" format="text" label="Sample file" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
94 </repeat>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
95 <repeat name="sample_name_repeat" title="Sample name to be included in the analysis">
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
96 <param name="sample_name" type="text" label="Sample name" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
97 </repeat>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
98 <tests>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
99 <test>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
100 <param name="reference_source_selector" value="history" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
101 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
102 <param name="input_bam" value="gatk/gatk_table_recalibration/gatk_table_recalibration_out_1.bam" ftype="bam" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
103 <param name="number" value="-1" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
104 <param name="platform" value="" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
105 <param name="read_group" value="" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
106 <param name="sample_file_repeat" value="0" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
107 <param name="sample_name_repeat" value="0" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
108 <param name="gatk_param_type_selector" value="basic" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
109 <output name="output_bam" file="gatk/gatk_table_recalibration/gatk_table_recalibration_out_1.bam" ftype="bam" compare="contains"/>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
110 <output name="output_log" file="gatk/gatk_print_reads/gatk_print_reads_out_1.log.contains" compare="contains" />
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
111 </test>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
112 </tests>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
113 <help>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
114 **What it does**
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
115
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
116 PrintReads can dynamically merge the contents of multiple input BAM files, resulting in merged output sorted in coordinate order.
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
117
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
118 For more information on the GATK Print Reads Walker, see this `tool specific page &lt;http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_gatk_walkers_PrintReadsWalker.html&gt;`_.
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
119
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
120 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Best_Practice_Variant_Detection_with_the_GATK_v3&gt;`_.
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
121
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
122 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Frequently_Asked_Questions&gt;`_.
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
123
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
124 ------
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
125
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
126 **Inputs**
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
127
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
128 GenomeAnalysisTK: PrintReads accepts one or more BAM or SAM input files.
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
129
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
130
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
131 **Outputs**
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
132
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
133 The output is in BAM format.
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
134
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
135
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
136 Go `here &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Input_files_for_the_GATK&gt;`_ for details on GATK file formats.
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
137
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
138 -------
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
139
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
140 **Settings**::
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
141
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
142 number int -1 Print the first n reads from the file, discarding the rest
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
143 platform String NA Exclude all reads with this platform from the output
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
144 readGroup String NA Exclude all reads with this read group from the output
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
145 sample_file Set[File] [] File containing a list of samples (one per line). Can be specified multiple times
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
146 sample_name Set[String] [] Sample name to be included in the analysis. Can be specified multiple times.
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
147
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
148 @CITATION_SECTION@
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
149 </help>
e768f4851646 Imported from capsule None
devteam
parents:
diff changeset
150 </tool>