annotate gbsx_demultiplexer.xml @ 19:84737a8fddb0 draft

Uploaded
author koen
date Wed, 13 Jan 2016 11:47:27 -0500
parents 9dc99f2deb3d
children 32ee036c156a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
1 <tool id="gbsx_demultiplexer" name="GBSX: Demultiplexer" force_history_refresh="True" version="1.1.5">
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
2 <description>demultiplexes inline barcodes from GBS and RAD experiments</description>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
3 <requirements>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
4 <requirement type="set_environment">GBSX_PATH</requirement>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
5 <requirement type="package" version="1.1.5">GBSX</requirement>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
6 </requirements>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
7 <command interpreter="sh">
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
8 #if $singleOrPaired.SR_PE_select=="SR"
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
9 gbsx_demultiplexer.sh $SR_Read 0 $info_file $barcodeMismatch $enzymeMismatch $rad_gbs_select $demultiplex_stats
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
10 #else
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
11 gbsx_demultiplexer.sh $PE_Read1 $PE_Read2 $info_file $barcodeMismatch $enzymeMismatch $rad_gbs_select $demultiplex_stats
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
12 #end if
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
13 </command>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
14 <inputs>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
15 <conditional name="singleOrPaired">
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
16 <param name="SR_PE_select" type="select" label="How did you sequence?">
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
17 <option value="SR">Single Read</option>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
18 <option value="PE">Paired End</option>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
19 </param>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
20 <when value="SR">
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
21 <param name="SR_Read" format="fastq" type="data" label="Single Read Fastq File" />
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
22 </when>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
23 <when value="PE">
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
24 <param name="PE_Read1" format="fastq" type="data" label="Paired End Fastq File Read 1" />
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
25 <param name="PE_Read2" format="fastq" type="data" label="Paired End Fastq File Read 2" />
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
26 </when>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
27 </conditional>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
28 <param name="info_file" format="tabular" type="data" label="Info File" help="see help below" />
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
29 <param name="barcodeMismatch" size="4" type="integer" value="1" min="0" max="3" label="Number of mismatches allowed in the barcode:" />
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
30 <param name="enzymeMismatch" size="4" type="integer" value="1" min="0" max="3" label="Number of mismatches allowed in the enzyme cutsite:" />
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
31
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
32
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
33 <param name="rad_gbs_select" size="4" type="select" label="Experiment type:" help="see help below" >
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
34 <option value="false">GBS</option>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
35 <option value="true">RAD</option>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
36 </param>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
37 </inputs>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
38 <outputs>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
39 <data format="tabular" name="demultiplex_stats" label="GBSX: Demultiplexer: Demultiplex stats" />
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
40 <data format="txt" name="report">
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
41 <discover_datasets pattern="__designation__" ext="fastq" directory="gbsx_demultiplex" visible="true" />
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
42 </data>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
43 </outputs>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
44
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
45 <tests>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
46 <test>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
47 <param name="SR_Read" value="gbsx_demultiplex_data.R1.fastq"/>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
48 <param name="PE_Read1" value="gbsx_demultiplex_data.R1.fastq"/>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
49 <param name="PE_Read2" value="gbsx_demultiplex_data.R2.fastq"/>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
50 <param name="info_file" value="gbsx_demultiplex_barcode_list.tsv"/>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
51 <param name="barcodeMismatch" value="1"/>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
52 <param name="enzymeMismatch" value="1"/>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
53 <param name="rad_gbs_select" value="false"/>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
54 <output name="demultiplex_stats" file="gbsDemultiplex.stats"/>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
55 </test>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
56 </tests>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
57
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
58 <help>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
59
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
60 .. class:: infomark
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
61
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
62 **Overview**
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
63
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
64 Genotyping by Sequencing is an emerging technology for cost effective variant discovery and genotyping. However, current analysis tools do not fulfill all experimental design and analysis needs.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
65
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
66 GBSX is a package of tools to first aid in experimental design, including choice of enzymes and barcode design. Secondly, it provides a first analysis step to demultiplex samples using in-line barcodes, providing fastq files that can easily be plugged into existing variant analysis pipelines.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
67
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
68 ----
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
69
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
70 **What it does**
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
71
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
72 This toolkit demultiplexes the samples using inline barcodes, for GBS and RAD experiments.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
73
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
74 For the demultiplexing we adjust the original barcode_list.txt file. Sample names are added in the first column, the second column will be the generated barcodes, the last column will be the restriction enzyme.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
75
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
76 Only the most used options are included. For more options, please use the command line version of GBSX.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
77
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
78 --------
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
79
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
80 **Help**
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
81
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
82 This program demultiplexes fastq files obtained from sequencing with inline barcodes. Like used in GBS, RAD, ... protocols.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
83
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
84 You can demultiplex Single Read and Paired end experiments. The correct sequence method can be selected with the 'How did you sequence?' parameter. Paired end libraries must be split in 2 files, with the regular Read1 and Read2 fastq file definitions.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
85
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
86 Info File: this is a tab delimeted file without headings, with three (or more) columns: sample name (only letters, numbers and underscores are allowed), sequence of the barcode, name of the enzyme, name of the second enzyme (optional, can be an empty string), the second barcode (optional, can be an empty string). This can be the output of the GBSX: Barcode Generator.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
87
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
88 Number of mismatches allowed leaves an option open for the recovering of possible sequencing errors.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
89
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
90 Experiment type: GBS is the Genotype-by-sequencing protocol where the sequenced reads are inlineBarcode-RestrictionEnzyme-insert-RestrictionEnzyme-CommonAdaptor. RAD is the Restriction site Associated DNA protocol where the sequenced reads are inlineBarcode-RestrictionEnzyme-insert-CommonAdaptor.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
91
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
92 Note: if you want to demultiplex data containing inline barcodes, without restriction enzymes, you should use the RAD parameter and give NA as Restriction Enzyme. The sequenced reads are inlineBarcode-insert-CommonAdaptor.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
93
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
94 The used Common Adaptor is: AGATCGGAAGAGCG
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
95
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
96 After the tool finished running, a history refresh is needed.
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
97
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
98 ----
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
99
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
100 **Created by:**
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
101
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
102 Koen Herten,
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
103
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
104 Genomics Core Leuven,
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
105
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
106 Belgium
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
107
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
108 ----
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
109
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
110 **Project links:**
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
111
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
112 https://github.com/GenomicsCoreLeuven/GBSX
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
113
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
114 ----
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
115
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
116 **Integrated by:**
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
117
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
118 Koen Herten
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
119
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
120 Genomics Core
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
121
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
122 Center for Human Genetics
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
123
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
124 UZ – KU Leuven
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
125
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
126 Herestraat 49 PO box 602
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
127
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
128 B-3000 Leuven, Belgium
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
129
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
130 If you use this tool in Galaxy, please cite:
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
131
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
132 </help>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
133 <citations>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
134 <citation type="doi">10.1186/s12859-015-0514-3</citation>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
135
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
136 <citation type="bibtex">@INPROCEEDINGS{
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
137 author = {Herten, Koen and Hestand, Matthew S. and Vermeesch, Joris R. and Van Houdt, Jeroen KJ},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
138 doi = {10.1186/s12859-015-0514-3},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
139 issn = {1471-2105},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
140 journal = {BMC Bioinformatics},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
141 number = {1},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
142 pages = {1–6},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
143 title = {GBSX: a toolkit for experimental design and demultiplexing genotyping by sequencing experiments},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
144 url = {http://dx.doi.org/10.1186/s12859-015-0514-3},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
145 volume = {16},
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
146 year = {2015}
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
147 }</citation>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
148 </citations>
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
149
9dc99f2deb3d Uploaded gbsx_demultiplexer.xml
koen
parents:
diff changeset
150 </tool>