annotate macros.xml @ 0:424f44e2124e draft

Initial upload
author gbcs-embl-heidelberg
date Wed, 25 Nov 2015 12:37:28 -0500
parents
children 88ebcd1ced0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
1 <macros>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
2
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
3 <token name="@single_or_paired_cmd@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
4 #if str( $library.type ) == "single":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
5 F1=${library.input_1}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
6 #elif str( $library.type ) == "paired":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
7 F1=${library.input_1}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
8 F2=${library.input_2}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
9 SAME_HEADERS=${library.SAME_HEADERS}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
10 #else
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
11 ## prepare paired-end collection
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
12 F1=${library.input_1.forward}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
13 F2=${library.input_1.reverse}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
14 SAME_HEADERS=${library.SAME_HEADERS}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
15 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
16 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
17
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
18 <xml name="paired_options">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
19 <when value="paired">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
20 <param name="input_1" format="fastq" type="data" label="FASTQ file #1"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
21 <param name="input_2" format="fastq" type="data" label="FASTQ file #2"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
22 <yield />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
23 <param name="SAME_HEADERS" type="boolean"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
24 label="Ensure headers of both reads of a pair are identical (SAME_HEADERS)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
25 help="Only applies if barcodes are added to the header (option ADD)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
26 truevalue="true"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
27 falsevalue="false" checked="false"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
28 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
29 <when value="paired_collection">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
30 <param name="input_1" format="fastq" type="data_collection" collection_type="paired"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
31 label="FASTQ Paired Dataset"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
32 <yield />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
33 <param name="SAME_HEADERS" type="boolean"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
34 label="Ensure headers of both reads of a pair are identical (SAME_HEADERS)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
35 help="Only applies if barcodes are added to the header (option ADD)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
36 truevalue="true"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
37 falsevalue="false" checked="false"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
38 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
39 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
40
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
41 <token name="@single_or_paired_illu_cmd@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
42 @single_or_paired_cmd@
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
43 I1=$library.I1
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
44 #if str( $library.type ) != "single":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
45 #if str( $library.I2_CONDITIONAL.I2_AVAILABLE ) == "true":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
46 I2=${library.I2_CONDITIONAL.I2}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
47 BRED=${library.I2_CONDITIONAL.BRED_CONDITIONAL.BRED}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
48 #if str( $library.I2_CONDITIONAL.BRED_CONDITIONAL.BRED ) == "true":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
49 STRICT=${library.I2_CONDITIONAL.BRED_CONDITIONAL.STRICT}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
50 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
51 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
52 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
53 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
54
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
55 <xml name="single_or_paired_illu">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
56 <conditional name="library">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
57 <param name="type" type="select" label="Is this single or paired library">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
58 <option value="single">Single-end</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
59 <option value="paired">Paired-end</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
60 <option value="paired_collection">Paired-end Dataset Collection</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
61 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
62 <when value="single">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
63 <param name="input_1" format="fastq" type="data" label="FASTQ file"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
64 <param name="I1" type="data" format="fastq" label="First Index File"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
65 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
66 <expand macro="paired_options">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
67 <param name="I1" type="data" format="fastq" label="First Index File"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
68 <conditional name="I2_CONDITIONAL">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
69 <param name="I2_AVAILABLE" type="select" label="Do you have a second index file?">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
70 <option value="true">Yes</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
71 <option value="false" selected="true">No</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
72 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
73 <when value="true">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
74 <param name="I2" type="data" format="fastq" label="Second Index File"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
75 <expand macro="bred_conditional"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
76 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
77 <when value="false"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
78 </conditional>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
79 </expand>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
80 </conditional>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
81 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
82
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
83 <xml name="single_or_paired_general">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
84 <conditional name="library">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
85 <param name="type" type="select" label="Is this single or paired library">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
86 <option value="single">Single-end</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
87 <option value="paired">Paired-end</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
88 <option value="paired_collection">Paired-end Dataset Collection</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
89 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
90 <when value="single">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
91 <param name="input_1" format="fastq" type="data" label="FASTQ file"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
92 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
93 <expand macro="paired_options">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
94 <yield />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
95 </expand>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
96 </conditional>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
97 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
98
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
99 <token name="@demultiplex_paired_end_cmd_options@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
100 BPOS=$library.BPOS_CONDITIONAL.BPOS
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
101 #if str( $library.BPOS_CONDITIONAL.BPOS ) == "BOTH":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
102 BM=${library.BPOS_CONDITIONAL.BM_CONDITIIONAL.BM}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
103 #if str( $library.BPOS_CONDITIONAL.BM_CONDITIIONAL.BM ) == "BOTH":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
104 BRED=${library.BPOS_CONDITIONAL.BM_CONDITIIONAL.BRED_CONDITIONAL.BRED}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
105 #if str( $library.BPOS_CONDITIONAL.BM_CONDITIIONAL.BRED_CONDITIONAL.BRED ) == "true":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
106 STRICT=${library.BPOS_CONDITIONAL.BM_CONDITIIONAL.BRED_CONDITIONAL.STRICT}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
107 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
108 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
109 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
110 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
111
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
112 <xml name="demultiplex_paired_end_options">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
113 <conditional name="BPOS_CONDITIONAL">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
114 <param name="BPOS" type="select" label="Barcode read position (BPOS)" help="where are the barcodes">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
115 <option value="READ_1" selected="true">READ_1 (beginning of read from the first fastq file)</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
116 <option value="READ_2">READ_2 (beginning of read from the second fastq file)</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
117 <option value="BOTH">BOTH (beginning of both reads)</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
118 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
119 <when value="READ_1"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
120 <when value="READ_2"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
121 <when value="BOTH">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
122 <conditional name="BM_CONDITIIONAL">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
123 <param name="BM" type="select" label="Barcode for sample matching (BM)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
124 help="which barcode should be used for sample look up (BM option)." >
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
125 <option value="READ_1" selected="true">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
126 READ_1 (beginning of read from the first fastq file)
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
127 </option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
128 <option value="READ_2">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
129 READ_2 (beginning of read from the second fastq file)
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
130 </option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
131 <option value="BOTH">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
132 BOTH (beginning of both reads)
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
133 </option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
134 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
135 <when value="READ_1"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
136 <when value="READ_2"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
137 <when value="BOTH">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
138 <expand macro="bred_conditional"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
139 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
140 </conditional>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
141 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
142 </conditional>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
143 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
144
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
145 <xml name="bred_conditional">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
146 <conditional name="BRED_CONDITIONAL">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
147 <param name="BRED" type="select" label="Redundant barcodes (BRED)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
148 help="are the barcodes REDUNDANT i.e. do they both resolve to the same sample.">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
149 <option value="true" selected="true">Yes</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
150 <option value="false">No</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
151 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
152 <when value="true">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
153 <param name="STRICT" type="boolean" label="Strict (S)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
154 truevalue="true"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
155 falsevalue="false"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
156 checked="false"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
157 />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
158 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
159 <when value="false"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
160 </conditional>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
161 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
162
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
163 <token name="@barcode_option_cmd@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
164 #if str( $barcodes.barcode_list_type_con ) == "text":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
165 BARCODE_FILE=${barcode_file_from_text}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
166 #else if str( $barcodes.barcode_list_type_con ) == "file":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
167 BARCODE_FILE=${barcodes.BARCODE_FILE}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
168 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
169 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
170
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
171 <xml name="barcode_option">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
172 <conditional name="barcodes">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
173 <param name="barcode_list_type_con" type="select" label="Barcode list input type">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
174 <option value="file" selected="true">Use a tab-delimited file from the history</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
175 <option value="text">Paste the barcodes list in a text field within the form</option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
176 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
177
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
178 <when value="file">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
179 <param name="BARCODE_FILE" type="data" format="tabular,txt" label="Barcode List"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
180 help="Barcode list format: one sample per line. First column is sample name and second is the
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
181 barcode, separated by tab or space. A third and fourth column can be used to specify the resulting
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
182 file names. See help below."/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
183 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
184
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
185 <when value="text">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
186 <param name="barcode_text" type="text" area="True" size="10x30"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
187 value="sample_name\tbarcode\n" label="Barcode List"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
188 help="Barcode list format: one sample per line. First column is sample name and second is the
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
189 barcode, separated by tab or space. A third and fourth column can be used to specify the resulting
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
190 file names. See help below.">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
191 <sanitizer>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
192 <valid initial="string.printable"></valid>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
193 <mapping initial="none"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
194 </sanitizer>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
195 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
196 </when>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
197 </conditional>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
198 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
199
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
200 <xml name="barcode_config_file">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
201 <configfile name="barcode_file_from_text">#set from_text_area = ''
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
202 #if str( $barcodes.barcode_list_type_con ) == "text":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
203 #set from_text_area = $barcodes.barcode_text
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
204 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
205 ${from_text_area}</configfile>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
206 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
207
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
208 <token name="@barcode_len_cmd@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
209 #if str( $LEN ) != "":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
210 BCLEN=$LEN
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
211 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
212 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
213
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
214 <xml name="barcode_len_option">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
215 <param name="LEN" type="text" value="" label="Barcode Length (LEN)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
216 help="If 'Barcode read position'=BOTH and 'Redundant barcodes'=False, two distinct
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
217 lengths can be provided using the syntax LEN=X:Z where X and Z are 2 integers representing
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
218 the barcode length for read_1 and read_2 respectively. Default: empty"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
219 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
220 <xml name="clip_barcode">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
221 <param name="CLIP_BARCODE" type="boolean" label="Remove barcode sequence from read (C)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
222 truevalue="true" falsevalue="false" checked="true"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
223 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
224
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
225 <token name="@demultiplexer_common_options_cmd@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
226 ADD=${ADD}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
227 MM=$MM
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
228 MMD=$MMD
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
229 Q=$MIN_BASE_QUALITY
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
230 QUALITY_FORMAT=$QUALITY_FORMAT
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
231 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
232 <xml name="demultiplexer_common_options">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
233 <param name="ADD" type="boolean"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
234 label="Add matched barcode at the end of the read header (ADD)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
235 truevalue="true"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
236 falsevalue="false"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
237 checked="true"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
238 />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
239 <param name="MM" type="text" value="1" label="Maximum Mismatches (MM)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
240 help="Maximum mismatches for a barcode to be considered a match." />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
241
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
242 <param name="MMD" type="text" value="1" label="Minimum mismatch difference (MMD)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
243 help="Minimum difference between number of mismatches in the best and second best barcodes for a barcode
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
244 to be considered a match." />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
245
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
246 <param name="MIN_BASE_QUALITY" type="text" value="10" label="Minimum base quality (Q)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
247 help="Any barcode bases falling below this quality will be
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
248 considered a mismatch even in the bases match." />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
249
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
250 <param name="QUALITY_FORMAT" type="select" label="Fastq Quality Format (V)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
251 help="How are the quality values encoded in the fastq. Either 'Solexa' for
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
252 pre-pipeline 1.3 style scores (solexa scaling + 66), 'Illumina' for pipeline 1.3 and
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
253 above (phred scaling + 64) or 'Standard' for phred scaled scores with a character shift
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
254 of 33.">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
255 <option value="Standard" selected="true">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
256 Fastq - Illumina Casava v1.8 with Sanger coding quality (phred scaling + 33)
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
257 </option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
258 <option value="Illumina">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
259 Fastq - Illumina v1.3 or above coding of quality (phred scaling + 64)
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
260 </option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
261 <option value="Solexa">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
262 Fastq - Solexa-style quality (solexa scaling + 66)
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
263 </option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
264 <option value="null">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
265 Detect automatically
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
266 </option>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
267 </param>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
268 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
269
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
270 <token name="@demultiplexer_common_output_options_cmd@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
271 KEEP_UNASSIGNED_READ=$KEEP_UNASSIGNED_READ
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
272 STATS_ONLY=${adv_options.STATS_ONLY}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
273 #if str( $adv_options.DIAG ) == "true":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
274 BARCODE_DIAG_FILE=$BARCODE_DIAG_FILE
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
275 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
276 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
277 <xml name="demultiplexer_common_output_options">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
278 <param name="KEEP_UNASSIGNED_READ" type="boolean" label="Keep unassigned reads (KEEP_UNASSIGNED_READ)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
279 truealue="true"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
280 falsevalue="false"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
281 checked="true"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
282 />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
283 <section name="adv_options" title="Advanced Options" expanded="False">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
284 <param name="DIAG" type="boolean" label="Output barcode match reporting file (DIAG)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
285 truevalue="true" falsevalue="false" checked="false"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
286 help="This file will
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
287 contain a line per read pair with the barcode best matching the read subsequence or 'null' when no
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
288 match is found according to matching parameters. This file is useful for debugging or further
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
289 processing in case both ends are barcoded."/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
290 <param name="STATS_ONLY" type="boolean" label="Only produce metric and diagnostic reports (STATS_ONLY)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
291 truevalue="true" falsevalue="false" checked="false"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
292 help="do not demultiplex." />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
293 </section>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
294 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
295
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
296 <token name="@common_options_cmd@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
297 XT=${XT}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
298 ZT=${ZT}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
299 #if str( $RCHAR ) != "":
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
300 RCHAR=${RCHAR}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
301 #end if
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
302 GZ=${GZ}
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
303 OUTPUT_DIR=results
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
304 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
305 <xml name="common_options">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
306 <param name="XT" type="text" value="0"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
307 label="Extra number of bases to be trimmed right after the barcode (XT)" />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
308 <param name="ZT" type="text" value="0"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
309 label="Extra number of bases to be trimmed from the read end (ZT)" />
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
310
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
311 <param name="RCHAR" type="text"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
312 label="Replace white space in the read name/header with speficied symbols (RCHAR)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
313 help="Set to empty for no replacement"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
314 value=":"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
315
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
316 <param name="GZ" type="boolean" hidden="true" label="Compress output (GZ)"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
317 help="will result in fastq.gz files."
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
318 truevalue="true"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
319 falsevalue="false"
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
320 checked="false"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
321 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
322
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
323 <token name="@demultiplexer_common_outputs_cmd@">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
324 METRICS_FILE_NAME=$METRICS_FILE_NAME
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
325 </token>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
326 <xml name="demultiplexer_common_outputs">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
327 <data name="METRICS_FILE_NAME" format="tabular" label="Je-Demultiplex result">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
328 <!--<discover_datasets pattern="(?P&lt;name&gt;.*)\.txt" ext="fastqsanger"-->
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
329 <discover_datasets pattern="(?P&lt;name&gt;.*)\.txt" directory="results" visible="true" ext="fastqsanger"/>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
330 </data>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
331 <data name="BARCODE_DIAG_FILE" format="tabular" label="Barcode statistics">
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
332 <filter>(adv_options['DIAG'] == 'true')</filter>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
333 </data>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
334 </xml>
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
335
424f44e2124e Initial upload
gbcs-embl-heidelberg
parents:
diff changeset
336 </macros>