annotate reheader.xml @ 0:6231ae8f87b8

Uploaded
author wolma
date Wed, 11 Feb 2015 08:29:02 -0500
parents
children a548b3c6ed00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
1 <tool id="reheader" name="Reheader BAM file">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
2
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
3 <description>From a BAM file generate a new file with the original header (if any) replaced or modified by that found in a second SAM file</description>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
4 <version_command>mimodd version -q</version_command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
5 <command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
6 #if ($str($rg.treat_rg) != "ignore" and $str($rg.rginfo.source) == "from_form") or $str($co.treat_co) != "ignore":
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
7 mimodd header
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
8 #if $str($rg.treat_rg) != "ignore" and $str($rg.rginfo.source) == "from_form":
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
9 #for $rginfo in $rg.rginfo.rg
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
10 #if $str($rginfo.source_id):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
11 --rg-id "${rginfo.source_id}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
12 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
13 #if $str($rginfo.rg_sm):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
14 --rg-sm "${rginfo.rg_sm}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
15 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
16 #if $str($rginfo.rg_cn):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
17 --rg-cn "${rginfo.rg_cn}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
18 #else:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
19 --rg-cn ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
20 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
21 #if $str($rginfo.rg_ds):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
22 --rg-ds "${rginfo.rg_ds}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
23 #else:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
24 --rg-ds ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
25 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
26 #if $str($rginfo.rg_date):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
27 --rg-dt "${rginfo.rg_date}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
28 #else:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
29 --rg-dt ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
30 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
31 #if $str($rginfo.rg_lb):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
32 --rg-lb "${rginfo.rg_lb}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
33 #else:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
34 --rg-lb ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
35 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
36 #if $str($rginfo.rg_pl):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
37 --rg-pl "${rginfo.rg_pl}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
38 #else:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
39 --rg-pl ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
40 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
41 #if $str($rginfo.rg_pi):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
42 --rg-pi "${rginfo.rg_pi}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
43 #else:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
44 --rg-pi ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
45 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
46 #if $str($rginfo.rg_pu):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
47 --rg-pu "${rginfo.rg_pu}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
48 #else:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
49 --rg-pu ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
50 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
51 #end for
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
52 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
53 #if $str($co.treat_co) != "ignore":
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
54 --co
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
55 #for $comment in $co.coinfo
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
56 #if $str($comment.line):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
57 "${comment.line}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
58 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
59 #end for
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
60 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
61 |
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
62 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
63 mimodd reheader "$inputfile" --sq ignore
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
64 --rg ${rg.treat_rg}
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
65 #if $str($rg.treat_rg) != "ignore":
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
66 #if $str($rg.rginfo.source) == "from_file":
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
67 "${rg.rginfo.data}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
68 #else:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
69 -
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
70 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
71 #for $rgmapping in $rg.rginfo.rg
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
72 #if $str($rgmapping.source_id) and $str($rgmapping.rg_id):
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
73 "$str($rgmapping.source_id)" : "$str($rgmapping.rg_id)"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
74 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
75 #end for
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
76 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
77
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
78 --co ${co.treat_co}
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
79 #if $str($co.treat_co) != "ignore":
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
80 -
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
81 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
82
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
83 #set $restr = ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
84 #for $rename in $rg_renaming
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
85 #set $restr = $restr + ($str($rename.from) and $str($rename.to) and '"' + $str($rename.from) + '" : "' + $str($rename.to) + '"')
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
86 #end for
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
87 #if $restr
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
88 --rgm $restr
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
89 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
90
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
91 #set $restr = ""
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
92 #for $rename in $sq_renaming
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
93 #set $restr = $restr + ($str($rename.from) and $str($rename.to) and '"' + $str($rename.from) + '" : "' + $str($rename.to) + '"')
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
94 #end for
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
95 #if $restr
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
96 --sqm $restr
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
97 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
98
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
99 -o "$output"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
100 </command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
101
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
102 <macros>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
103 <macro name="getreadgroupinfo">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
104 <conditional name="rginfo">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
105 <param name="source" type="select" label="source of new read-group information" help="">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
106 <option value="from_file">existing SAM file</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
107 <option value="from_form">input form</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
108 </param>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
109 <when value="from_file">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
110 <param name="data" type="data" format="sam" label="read-group template file in SAM format" help="use the read group information found in this file" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
111 <repeat name="rg" title="custom read-group mapping" default="0" min="0" help="read-group information found in the input file, by default, gets updated / replaced with information from template file read-groups with matching IDs. Alternatively, you may specify explicit read-group mappings below.">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
112 <param name="source_id" type="text" label="modify input file information for read-group ID (will create the read-group if it does not exist)" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
113 <param name="rg_id" type="text" label="with template file information for read-group ID" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
114 </repeat>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
115 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
116 <when value="from_form">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
117 <repeat name="rg" title="new read-group info" default="1" min="1">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
118 <param name="source_id" type="text" label="read-group ID (will create the read-group if it does not exist)" help="required field" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
119 <param name="rg_id" type="hidden" value="" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
120 <param name="rg_sm" type="text" label="sample name" help="required field" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
121 <param name="rg_ds" type="text" label="description" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
122 <param name="rg_date" type="text" label="date (YY-MM-DD format) the run was produced" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
123 <param name="rg_cn" type="text" label="name of sequencing center" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
124 <param name="rg_lb" type="text" label="read-group library" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
125 <param name="rg_pl" type="text" label="platform/technology used to produce the reads" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
126 <param name="rg_pi" type="text" label="predicted median insert size" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
127 <param name="rg_pu" type="text" label="platform unit; unique identifier" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
128 </repeat>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
129 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
130 </conditional>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
131 </macro>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
132 </macros>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
133
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
134 <inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
135
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
136 <param name="inputfile" type="data" format="bam" label="input file in BAM format" help="the file to reheader." />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
137
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
138 <conditional name="rg">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
139 <param name="treat_rg" type="select" label="modify read-group information ?" help="Replace mode will ignore ALL existing read group information in the input file and use ONLY template information, Update mode will COPY existing input file information and UPDATE it with template information; choose No, ... to leave read-group information alone.">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
140 <option value="ignore">No, do not change read-groups.</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
141 <option value="update">Yes, update existing information</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
142 <option value="replace">Yes, replace existing information</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
143 </param>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
144 <when value="update">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
145 <expand macro="getreadgroupinfo" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
146 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
147 <when value="replace">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
148 <expand macro="getreadgroupinfo" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
149 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
150 </conditional>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
151
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
152 <conditional name="co">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
153 <param name="treat_co" type="select" label="modify comments in the input file ?" help="">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
154 <option value="ignore">No, do not change comments.</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
155 <option value="update">Yes, append new comments to existing ones</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
156 <option value="replace">Yes, replace all existing comments</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
157 </param>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
158 <when value="update">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
159 <repeat name="coinfo" title="comment line" default="0" min="0">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
160 <param name="line" type="text" size="80" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
161 </repeat>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
162 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
163 <when value="replace">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
164 <repeat name="coinfo" title="comment line" default="0" min="0">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
165 <param name="line" type="text" size="80" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
166 </repeat>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
167 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
168 </conditional>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
169
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
170 <repeat name="rg_renaming" title="rename read-group" default="0" min="0" help="Warning: changing read-group IDs may increase job runtime substantially.">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
171 <param name="from" type="text" size="30" label="old name" help="as it appears in the current input file header"/>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
172 <param name="to" type="text" size="30" label="new name" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
173 </repeat>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
174
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
175 <repeat name="sq_renaming" title="rename sequence" default="0" min="0" help="Warning: changing sequence names may increase job runtime substantially.">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
176 <param name="from" type="text" size="30" label="old name" help="as it appears in the current input file header"/>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
177 <param name="to" type="text" size="30" label="new name" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
178 </repeat>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
179
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
180 </inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
181
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
182 <outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
183 <data name="output" format="bam" label="(Re)headered bam file from MiModd ${tool.name} on ${on_string}">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
184 </data>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
185 </outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
186
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
187 <help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
188 .. class:: infomark
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
189
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
190 **What it does**
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
191
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
192 The tool generates a copy of the BAM input file with a modified header (i.e., metadata).
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
193
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
194 It can update or replace read-group information (i.e., information about the samples in the file), add or replace comment lines, and rename reference sequences declared in the header.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
195
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
196 The tool ensures that the resulting BAM file is valid and can be further processed by other MiModD tools and standard software like samtools. It aborts with an error message if a valid BAM file cannot be generated with the user-specified settings.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
197
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
198 The template information used to modify or replace the input file metadata is provided through forms or, in the case of read-group information, can be taken from an existing SAM file as can be generated, for example, with the *NGS Run Annotation* tool.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
199
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
200 </help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
201 </tool>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
202