annotate jemultiplexer.xml @ 1:9764802ffae8 draft

Uploaded
author gbcs-embl-heidelberg
date Wed, 03 Sep 2014 04:11:49 -0400
parents
children 321b695b1a33
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
1 <tool id="jedebarcoding" name="Jemultiplexer">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
2 <description>Demultiplexes multiplexed data</description>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
3 <requirements>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
4 <requirement type="package" version=">=1.6">java</requirement>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
5 </requirements>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
6 <command interpreter="python">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
7 jemultiplexer.py
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
8 $MpxData1
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
9 $output1
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
10 $output1.id
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
11 $bsinputtype.barcodes
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
12 "$bsinputtype.barcode_list"
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
13 $__new_file_path__
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
14 $MpxData1.ext
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
15 $bcodelen
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
16 $qualityFormat
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
17 $maxMismatches
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
18 $minBaseQuality
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
19 $minMismatchingDelta
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
20 $clipBarcodeCon.xTrimLen
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
21 $zTrimLen
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
22 $clipBarcodeCon.clipBarcode
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
23 $addBarcodeToHeader
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
24 $gzipOutput
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
25 $barcodeDiagFile
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
26 $rChar
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
27 #if $singlePaired.sPaired == "paired":
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
28 $singlePaired.barcodeReadPosCon.barcodeReadPos
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
29 #if $singlePaired.barcodeReadPosCon.barcodeReadPos == "BOTH":
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
30 $singlePaired.barcodeReadPosCon.barcodeForSampleMatchingCon.barcodeForSampleMatching
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
31 #if $singlePaired.barcodeReadPosCon.barcodeForSampleMatchingCon.barcodeForSampleMatching == "BOTH":
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
32 $singlePaired.barcodeReadPosCon.barcodeForSampleMatchingCon.redundantBarcodeCon.redundantBarcode
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
33 $singlePaired.barcodeReadPosCon.barcodeForSampleMatchingCon.redundantBarcodeCon.strict
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
34 $singlePaired.MpxData2
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
35 #else:
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
36 $singlePaired.barcodeReadPosCon.barcodeForSampleMatchingCon.redundantBarcode
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
37 $singlePaired.barcodeReadPosCon.barcodeForSampleMatchingCon.strict
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
38 $singlePaired.MpxData2
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
39 #end if
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
40 #else:
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
41 $singlePaired.barcodeReadPosCon.barcodeForSampleMatching
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
42 $singlePaired.barcodeReadPosCon.redundantBarcode
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
43 $singlePaired.barcodeReadPosCon.strict
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
44 $singlePaired.MpxData2
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
45 #end if
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
46 #else:
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
47 $singlePaired.barcodeReadPos
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
48 $singlePaired.barcodeForSampleMatching
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
49 $singlePaired.redundantBarcode
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
50 $singlePaired.strict
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
51 $singlePaired.MpxData2
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
52 #end if
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
53 </command>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
54 <inputs>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
55 <param type="data" format="gz,fastq" name="MpxData1" label="Compressed (or not) FASTQ file" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
56 <conditional name="singlePaired">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
57 <param name="sPaired" type="select" label="Is this library mate-paired?">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
58 <option value="single">Single-end</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
59 <option value="paired">Paired-end</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
60 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
61 <when value="single">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
62 <param name="MpxData2" type="hidden" value="single" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
63 <param name="barcodeReadPos" type="hidden" value="none" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
64 <param name="redundantBarcode" type="hidden" value="none" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
65 <param name="barcodeForSampleMatching" type="hidden" value="none" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
66 <param name="strict" type="hidden" value="none" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
67 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
68 <when value="paired">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
69 <param name="MpxData2" type="data" format="gz,fastq" label="Compressed (or not) FASTQ file" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
70 <conditional name="barcodeReadPosCon">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
71 <param name="barcodeReadPos" type="select" label="Barcode read position (BPOS)" help="where are the barcodes">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
72 <option value="READ_1" selected="true">READ_1 (beginning of read from the first fastq file)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
73 <option value="READ_2">READ_2 (beginning of read from the second fastq file)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
74 <option value="BOTH">BOTH (beginning of both reads)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
75 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
76 <when value="READ_1">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
77 <param name="redundantBarcode" type="hidden" value="true" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
78 <param name="barcodeForSampleMatching" type="hidden" value="BOTH" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
79 <param name="strict" type="hidden" value="false" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
80 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
81 <when value="READ_2">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
82 <param name="redundantBarcode" type="hidden" value="true" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
83 <param name="barcodeForSampleMatching" type="hidden" value="BOTH" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
84 <param name="strict" type="hidden" value="false" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
85 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
86 <when value="BOTH">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
87 <conditional name="barcodeForSampleMatchingCon">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
88 <param name="barcodeForSampleMatching" type="select" label="Barcode for sample matching (BM)" help="which barcode should be used for sample look up (BM option)." >
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
89 <option value="READ_1" selected="true">READ_1 (beginning of read from the first fastq file)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
90 <option value="READ_2">READ_2 (beginning of read from the second fastq file)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
91 <option value="BOTH">BOTH (beginning of both reads)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
92 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
93 <when value="READ_1">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
94 <param name="redundantBarcode" type="hidden" value="true" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
95 <param name="strict" type="hidden" value="false" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
96 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
97 <when value="READ_2">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
98 <param name="redundantBarcode" type="hidden" value="true" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
99 <param name="strict" type="hidden" value="false" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
100 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
101 <when value="BOTH">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
102 <conditional name="redundantBarcodeCon">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
103 <param name="redundantBarcode" type="select" label="Redundant barcodes (BRED)" help="are the barcode REDUNDANT i.e. do they both resolve to the same sample (BRED option).">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
104 <option value="true">True</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
105 <option value="false" selected="true">False</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
106 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
107 <when value="true">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
108 <param name="strict" type="select" label="Strict (S)" help="tells whether both barcodes should resolve to the same sample." >
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
109 <option value="true" selected="true">True</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
110 <option value="false">False</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
111 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
112 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
113 <when value="false">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
114 <param name="strict" type="hidden" value="false" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
115 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
116 </conditional>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
117 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
118 </conditional>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
119 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
120 </conditional>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
121 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
122 </conditional>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
123
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
124 <conditional name="bsinputtype">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
125 <param name="bsinputtype_selector" type="select" label="Barcode set input type" help="You can either submit a barcode file or paste the list in a text field. Note: one sample per line.">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
126 <option value="bs_file" selected="true">Use a .bs tab-delimited file in the history</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
127 <option value="bs_textfield">Paste the barcodes list in a text field within the form</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
128 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
129 <when value="bs_file">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
130 <param name="barcodes" type="data" format="bs" label="Barcode Set" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
131 <param name="barcode_list" type="hidden" value="none" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
132 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
133 <when value="bs_textfield">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
134 <param name="barcode_list" type="text" area="True" size="10x30" label="Barcode Set (&#60;span style=&#34;color:brown;&#34;&#62;one sample per line: &#38;#60&#59;sample_name&#38;#62&#59;&#38;#60&#59;tab or space&#38;#62&#59;&#38;#60&#59;barcode&#38;#62&#59;&#60;/span&#62;)"/>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
135 <param name="barcodes" type="hidden" value="none" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
136 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
137 </conditional>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
138
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
139 <param name="bcodelen" type="text" value="6" label="Barcode Length (LEN)" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
140
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
141 <param name="qualityFormat" type="select" label="Fastq Quality Format (V)" help="if you need other quality coding format, contact the galaxy administrators.">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
142 <option value="Standard" selected="true">Fastq - Illumina Casava V1.8 with Sanger coding quality (phred scaling + 33)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
143 <option value="Illumina">Fastq - Illumina v1.3 or above coding of quality (phred scaling + 64)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
144 <option value="Solexa">Fastq - Solexa-style quality (solexa scaling + 66)</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
145 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
146 <param name="maxMismatches" type="text" value="1" label="Maxinum Mismatches (MM)" help="maximum mismatches for a barcode to be considered a match." />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
147 <param name="minBaseQuality" type="text" value="10" label="Minimum base quality (Q)" help="any barcode bases falling below this quality will be considered a mismatch even in the bases match." />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
148 <param name="minMismatchingDelta" type="text" value="1" label="Minimum mismatch difference (MMD)" help="Minimum difference between number of mismatches in the best and second best barcodes for a barcode to be considered a match." />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
149 <param name="zTrimLen" type="text" value="0" label="Extra number of bases to be trimmed from the barcode end (ZT)" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
150 <conditional name="clipBarcodeCon">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
151 <param name="clipBarcode" type="select" label="Remove barcode sequence from read (C)" >
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
152 <option value="true" selected="true">True</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
153 <option value="false">False</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
154 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
155 <when value="true">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
156 <param name="xTrimLen" type="text" value="1" label="Extra number of base to be trimmed right after the barcode (XT)" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
157 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
158 <when value="false">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
159 <param name="xTrimLen" type="hidden" value="1" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
160 </when>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
161 </conditional>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
162 <param name="addBarcodeToHeader" type="select" label="Add matched barcode at the end of the read header (ADD)" >
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
163 <option value="true" selected="true">True</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
164 <option value="false">False</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
165 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
166 <param name="gzipOutput" type="select" label="Compress output (GZ)" >
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
167 <option value="true" selected="true">True</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
168 <option value="false">False</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
169 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
170 <param name="barcodeDiagFile" type="select" label="Output barcode match reporting file (DIAG)" >
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
171 <option value="false" selected="false">False</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
172 <option value="true">True</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
173 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
174 <param name="rChar" type="select" label="Replace white space in the read name/header with speficied symbols (RCHAR)" >
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
175 <option value="1" selected="1"> </option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
176 <option value="2">:</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
177 <option value="3">_</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
178 <option value="4">-</option>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
179 </param>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
180 </inputs>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
181 <outputs>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
182 <data format="html" name="output1" label="Demultiplexing stats on ${on_string}"/>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
183 <!-- Keep this as a nice example of reformating;
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
184 <data format="fastqsanger" name="output1" metadata_source="MpxData1" label="Demultiplexing stats on ${on_string}">
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
185 <change_format>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
186 <when input="MpxData1.ext" value="fastqillumina" format="fastqillumina" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
187 </change_format>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
188 </data> -->
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
189 </outputs>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
190
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
191 <tests>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
192 <test>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
193 <param name="MpxData1" value="C1WLBACXX_lane7_1_sequence.txt" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
194 <param name="MpxData2" value="C1WLBACXX_lane7_2_sequence.txt" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
195 <param name="sPaired" value="paired" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
196 <param name="bsinputtype_selector" value="bs_file" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
197 <param name="barcodes" value="correct_barcodes_PE_both-ends_with_fnames.txt" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
198 <param name="barcodeReadPos" value="BOTH" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
199 <param name="barcodeForSampleMatching" value="BOTH" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
200 <param name="redundantBarcode" value="false" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
201 <param name="bcodelen" value="6" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
202 <param name="qualityFormat" value="Standard" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
203 <param name="maxMismatches" value="3" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
204 <param name="minBaseQuality" value="20" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
205 <param name="minMismatchingDelta" value="2" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
206 <param name="zTrimLen" value="0" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
207 <param name="clipBarcode" value="true" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
208 <param name="xTrimLen" value="1" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
209 <param name="addBarcodeToHeader" value="true" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
210 <param name="gzipOutput" value="true" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
211 <param name="barcodeDiagFile" value="true" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
212 <param name="rChar" value="1" />
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
213 <output name="output1" file="result.html" ftype="html"/>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
214 </test>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
215 </tests>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
216
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
217 <help>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
218
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
219 **What it does**
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
220
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
221 Jemultiplexer : A fastq files demultiplexer with many neat options. Input files are fastq files, and can be in gzip compressed format (end in .gz).
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
222
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
223 Author: Charles Girardot (charles.girardot@embl.de).
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
224
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
225 Version: 1.0.3
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
226
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
227 ------
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
228
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
229 **Know what you are doing**
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
230
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
231 .. class:: warningmark
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
232
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
233 You will want to read the `documentation`__.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
234
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
235 .. __: http://gbcs.embl.de/tikiwiki/JemultiplexerDocHome
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
236
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
237 ------
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
238
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
239 **Jemultiplexer parameter list**
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
240
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
241 This is an exhaustive list of Jemultiplexer options::
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
242
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
243 FASTQ_FILE1=File
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
244 F1=File Input fastq file (optionally gzipped) for single end data, or first read in paired end data.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
245 Required.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
246
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
247 FASTQ_FILE2=File
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
248 F2=File Input fastq file (optionally gzipped) for the second read of paired end data.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
249 Default value: null.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
250
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
251 BARCODE_FILE=File
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
252 BF=File Barcode file describing sequence list and sample names. Tab-delimited file with 2
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
253 columns, with the sample in col1 and the corresponding barcode in col2.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
254 Note, make sure one sample per line.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
255 If multiple barcode map to the same sample, barcodes can be combined using the OR operator '|'.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
256 i.e. the file above can be re-written like
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
257 sample1 ATAT|GAGG
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
258 sample2 CCAA|TGTG
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
259 Finally, for the special situation of paired-end data in which barcodes differ at both
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
260 ends (ie BPOS=BOTH BRED=false BM=BOTH , see BRED option description), barcodes for read_1
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
261 and read_2 can be distinguished using a ':' separator i.e.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
262 sample1 ATAT:GAGG
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
263 sample2 CCAA:TGTG
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
264 Here understand that sample 1 is encoded with ATAT barcode at read_1 AND GAGG barcode at
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
265 read_2. Note that you can still combine barcodes using | e.g.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
266 sample1 ATAT|GAGG:CCAA|TGTG
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
267 would mean that sample 1 is mapped by the combination of barcode: ATAT OR GAGG at read_1
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
268 AND CCAA OR TGTG at read_2.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
269 Required.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
270
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
271 BARCODE_READ_POS=BarcodePosition
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
272 BPOS=BarcodePosition For paired-end data, where to expect the barcode(s) : READ_1 (beginning of read from
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
273 FASTQ_FILE_1), READ_2 (beginning of read from FASTQ_FILE_2), BOTH (beginning of both
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
274 reads). Automatically set to READ_1 in single end mode.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
275 Default value: BOTH. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
276 Possible values: {READ_1, READ_2, BOTH}
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
277
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
278 REDUNDANT_BARCODES=Boolean
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
279 BRED=Boolean For paired-end data and when BARCODE_READ_POS == BOTH, this option indicates if both
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
280 read's barcodes encode redundant information, which is the usual situation
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
281 (REDUNDANT_BARCODES=true) i.e. barcodes are supposed to be the same at both ends or to
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
282 resolve to the same sample (when a pool of barcodes has been used for each sample).
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
283 When REDUNDANT_BARCODES=false, the 2 barcodes potentially encode different
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
284 information. For example, only one of the barcodes encodes the sample the read belongs to
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
285 while the second barcode might be a random barcode to tell apart PCR artefacts from real
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
286 duplicates. Another example is when both barcodes should be used in a combined fashion
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
287 to resolve the sample. In the first example, you should use BPOS=BOTH BRED=false
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
288 BM=READ_1 while in the second example, you should have BPOS=BOTH BRED=false BM=BOTH (note
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
289 that with BPOS=BOTH BRED=true BM=BOTH), the behavior would be different as Jemultiplexer
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
290 would then check the STRICT option to perform sample resolution.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
291 Importantly, when BARCODE_READ_POS == BOTH AND REDUNDANT_BARCODES=false, BLEN, barcode
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
292 matching options (MM, MMD, Q) and read trimming/clipping options (XT, ZT) accept
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
293 different values for both barcodes in the form X:Z where X and Z are 2 integers.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
294 Default value: true. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
295 Possible values: {true, false}
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
296
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
297 BARCODE_FOR_SAMPLE_MATCHING=BarcodePosition
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
298 BM=BarcodePosition Automatically set to READ_1 in single end mode.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
299 For paired-end data and when BARCODE_READ_POS == BOTH, which barcode should be used to
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
300 resolve sample :
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
301 - use BM=READ_1 (beginning of read from FASTQ_FILE_1) if only this read should be used
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
302 for sample matching,
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
303 - use BM=READ_2 (beginning of read from FASTQ_FILE_2) if only this read should be used
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
304 for sample matching,
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
305 - use BM=BOTH (beginning of both reads) if both should be used ; when BM=BOTH, the
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
306 behaviour of Jemultiplexer is different based on the value of REDUNDANT_BARCODES.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
307 If REDUNDANT_BARCODES=true, the two barcodes are considered to map to the same sample
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
308 and Jemultiplexer uses the two barcodes according to the STRICT value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
309 If REDUNDANT_BARCODES=false, the barcode file should map a couple of barcode to each
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
310 sample (e.g. sample1 => AGAGTG:TTGATA) and Jemultiplexer needs both barcodes to find the
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
311 relevant sample. Note that this is the only situation in which all barcode matching
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
312 options (MM, MMD, Q) accept different values for both barcodes in the form X:Z where X
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
313 and Z are 2 integers.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
314 Default value: BOTH. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
315 Possible values: {READ_1, READ_2, BOTH}
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
316
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
317 STRICT=Boolean
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
318 S=Boolean For paired-end data and when BARCODE_READ_POS == BOTH and BM=BOTH, tells whether both
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
319 barcodes should resolve to the same sample. When true and if only one of the two reads
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
320 has a barcode match, the read pair is ignored. When false and if only one of the two
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
321 reads has a barcode match, the read pair is assigned to the corresponding sample ; in
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
322 cases where reads resolve to different samples, the read pair is ignored.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
323 Default value: false. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
324 Possible values: {true, false}
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
325
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
326 BCLEN=String
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
327 LEN=String Length of the barcode sequences, optional. Taken from barcode file when not given.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
328 In situations where BARCODE_READ_POS == BOTH AND REDUNDANT_BARCODES=false, two distinct
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
329 length can be provided using the syntax LEN=X:Z where X and Z are 2 integers representing
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
330 the barcode length for read_1 and read_2 respectively.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
331 Default value: null.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
332
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
333 MAX_MISMATCHES=String
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
334 MM=String Maximum mismatches for a barcode to be considered a match. MM=null is like MM=0
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
335 In situations where both barcodes are used for sample matching i.e. BPOS=BOTH BM=BOTH
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
336 (note that most likely BRED=false as it does not make great sense otherwise), two
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
337 distinct values can be given here using the syntax MM=X:Z where X and Z are 2 integers to
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
338 use for read_1 and read_2 respectively.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
339 Default value: 1. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
340
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
341 MIN_MISMATCH_DELTA=String
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
342 MMD=String Minimum difference between number of mismatches in the best and second best barcodes for
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
343 a barcode to be considered a match. MMD=null is like MMD=0
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
344 In situations where both barcodes are used for sample matching i.e. BPOS=BOTH BM=BOTH
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
345 (note that most likely BRED=false as it does not make great sense otherwise), two
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
346 distinct values can be given here using the syntax MMD=X:Z where X and Z are 2 integers
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
347 to use for read_1 and read_2 respectively.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
348 Default value: 1. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
349
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
350 MIN_BASE_QUALITY=String
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
351 Q=String Minimum base quality. Any barcode bases falling below this quality will be considered a
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
352 mismatch even in the bases match. Q=null is like Q=0.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
353 In situations where both barcodes are used for sample matching i.e. BPOS=BOTH BM=BOTH
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
354 (note that most likely BRED=false as it does not make great sense otherwise), two
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
355 distinct values can be given here using the syntax Q=X:Z where X and Z are 2 integers to
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
356 use for read_1 and read_2 respectively.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
357 Default value: 10. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
358
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
359 XTRIMLEN=String
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
360 XT=String Extra number of base to be trimmed right after the barcode (only used if
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
361 CLIP_BARCODE=true). Default is 1 as an extra 'T' (or 'A' depending how you see it) is
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
362 added for barcode ligation but this default will be adapated according to the rules
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
363 below. XT=null is like XT=0.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
364 When running paired-end, two distinct values can be given using the syntax XT=X:Z where X
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
365 and Z are 2 integers to use for read_1 and read_2 respectively. Note that even when
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
366 BPOS=READ_1 or BPOS=READ_2, a X:Y synthax can be given to trim the read w/o barcode as to
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
367 end up with reads of the same length (note that this can also be operated using ZT). If a
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
368 unique value is given, e.g. XT=1, while running paired-end the following rule applies :
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
369 (1) BPOS=READ_1 or BPOS=READ_2, no trim is applied at the read w/o barcode ; (2)
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
370 BPOS=BOTH, the value is used for both reads.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
371 Default value: 1. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
372
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
373 ZTRIMLEN=String
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
374 ZT=String Extra number of bases to be trimmed from the barcode end i.e. 3' end. Pretty handy when a
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
375 pipeline is set and you already know you'll trim read at a given size. ZT=null is like
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
376 ZT=0.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
377 When running paired-end, two distinct values can be given here using the syntax ZT=X:Z
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
378 where X and Z are 2 integers to use for read_1 and read_2 respectively. Note that even
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
379 when BPOS=READ_1 or BPOS=READ_2, a X:Y synthax can be given to trim the read w/o barcode
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
380 as to end up with reads of the same length (note that this can also be operated using
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
381 XT). Note that if a single value is passed, the value always aplly to both reads in
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
382 paired-end mode without further consideration.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
383 Default value: 0. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
384
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
385 CLIP_BARCODE=Boolean
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
386 C=Boolean Remove barcode sequence from read, as well as XTRIMLEN (and ZTRIMLEN) bases if
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
387 applicable, before writing to output file. If false, reads are written without
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
388 modification to output file. Apply to both barcodes when BPOS=BOTH.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
389 Default value: true. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
390 Possible values: {true, false}
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
391
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
392 ADD_BARCODE_TO_HEADER=Boolean
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
393 ADD=Boolean Add matched barcode at the end of the read header. Apply to both barcodes when BPOS=BOTH.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
394 If true, the string ':barcode' is added at the end of the read header with a ':' added
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
395 only if current read header does not end with ':'.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
396 If both reads of the pair have a barcode (i.e. BARCODE_READ_POS == BOTH), thenthe second
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
397 read also has its own matched barcode written. Else, the read without a barcode receives
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
398 the barcode from the barcoded read.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
399 For example :
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
400 '@D3FCO8P1:178:C1WLBACXX:7:1101:1836:1965 2:N:0:'
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
401 becomes
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
402 '@D3FCO8P1:178:C1WLBACXX:7:1101:1836:1965 2:N:0:BARCODE'
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
403 Default value: true. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
404 Possible values: {true, false}
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
405
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
406 QUALITY_FORMAT=FastqQualityFormat
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
407 V=FastqQualityFormat A value describing how the quality values are encoded in the fastq. Either 'Solexa' for
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
408 pre-pipeline 1.3 style scores (solexa scaling + 66), 'Illumina' for pipeline 1.3 and
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
409 above (phred scaling + 64) or 'Standard' for phred scaled scores with a character shift
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
410 of 33. If this value is not specified (or 'null' is given), the quality format will be
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
411 detected automatically.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
412 Default value: Standard. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
413 Possible values: {Solexa, Illumina, Standard}
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
414
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
415 GZIP_OUTPUTS=Boolean
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
416 GZ=Boolean Compress output s_l_t_barcode.txt files using gzip and append a .gz extension to the filenames.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
417 Default value: true. This option can be set to 'null' to clear the default value.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
418 Possible values: {true, false}
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
419 BARCODE_DIAG_FILE=String
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
420 DIAG=String Name for a barcode match reporting file (not generated by default).Either a name
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
421 (in which case the file will be created in the output dir) or full path. This file will contain
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
422 a line per read pair with the barcode best matching the read subsequence or 'null' when no match
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
423 is found accordign to matching parameters and the final selected sample. This file is useful for
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
424 debugging or further processing in case both ends are barcoded.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
425 Default value: null
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
426
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
427 READ_NAME_REPLACE_CHAR=String
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
428 RCHAR=String Replace spaces in read name/header using provided character. This is particularly handy
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
429 when you need to retain ADDed barcode in read name/header during mapping (everything
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
430 after space in read name is usually clipped in BAM files). For example, with RCHAR=':' :
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
431 '@D3FCO8P1:178:C1WLBACXX:7:1101:1836:1965 2:N:0:'
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
432 becomes
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
433 '@D3FCO8P1:178:C1WLBACXX:7:1101:1836:1965:2:N:0:BARCODE'
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
434 Default value: null.
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
435 </help>
9764802ffae8 Uploaded
gbcs-embl-heidelberg
parents:
diff changeset
436 </tool>