annotate gbsx_barcodeGenerator.xml @ 2:b0d5949b88dd draft

Uploaded gbsx_demultiplexer.sh
author koen
date Wed, 13 Jan 2016 10:45:58 -0500
parents 29fc2bb7bc18
children 609ad9165ba2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
1 <tool id="gbsx_barcodeGenerator" name="GBSX: Barcode Generator" version="1.1.5">
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
2 <description>creates inline barcodes for a given enzyme</description>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
3 <requirements>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
4 <requirement type="set_environment">GBSX_PATH</requirement>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
5 <requirement type="package" version="1.1.5">GBSX</requirement>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
6 </requirements>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
7 <command interpreter="sh">gbsx_barcodeGenerator.sh $barcode $enzyme $barcode_list $barcode_summary</command>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
8 <inputs>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
9 <param name="barcode" size="4" type="integer" value="5" min="1" max="20000" label="Number of barcodes to generate" />
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
10 <param name="enzyme" size="4" type="select" label="The enzyme to use" >
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
11 <option value="ApeKI">ApeKI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
12 <option value="PstI">PstI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
13 <option value="EcoT22I">EcoT22I</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
14 <option value="PasI">PasI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
15 <option value="HpaII">HpaII</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
16 <option value="MspI">MspI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
17 <option value="PstI-EcoT22I">PstI-EcoT22I</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
18 <option value="PstI-MspI">PstI-MspI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
19 <option value="PstI-TaqI">PstI-TaqI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
20 <option value="SbfI-MspI">SbfI-MspI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
21 <option value="AsiSI-MspI">AsiSI-MspI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
22 <option value="BssHII-MspI">BssHII-MspI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
23 <option value="FseI-MspI">FseI-MspI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
24 <option value="SalI-MspI">SalI-MspI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
25 <option value="ApoI">ApoI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
26 <option value="BamHI">BamHI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
27 <option value="MseI">MseI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
28 <option value="Sau3AI">Sau3AI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
29 <option value="RBSTA">RBSTA</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
30 <option value="RBSCG">RBSCG</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
31 <option value="NspI">NspI</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
32 <option value="AvaII">AvaII</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
33 <option value="NA">NA</option>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
34 </param>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
35 </inputs>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
36 <outputs>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
37 <data format="tabular" name="barcode_list" label="GBSX: Barcode Generator: Barcode List" />
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
38 <data format="txt" name="barcode_summary" label="GBSX: Barcode Generator: Summary" />
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
39 </outputs>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
40
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
41 <tests>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
42 <test>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
43 <param name="barcode" value="5"/>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
44 <param name="enzyme" value="ApeKI"/>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
45 <output name="barcode_list">
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
46 <assert_contents>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
47 <has_n_columns n="3" />
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
48 <has_text_matching expression="^sample[1-9]+\t[AGCT]*\tApeKI" />
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
49 </assert_contents>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
50 </output>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
51 </test>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
52 </tests>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
53
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
54 <help>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
55
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
56 .. class:: infomark
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
57
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
58 **Overview**
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
59
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
60 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.
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
61
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
62 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.
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
63
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
64 ----
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
65
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
66 This toolkit generates the given number of variating barcodes in combination with the given enzyme for GBS and RAD experiments.
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
67
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
68 The outcome of this tool will always be different. This is because the generated barcodes are completely random. The best practice is to manually check the position matrix to see if every bases occurs equally on every position.
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
69
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
70 Only the most used options are included. For more options, please use the command line version of GBSX.
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
71
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
72 ----
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
73
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
74 **Created by:**
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
75
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
76 Koen Herten,
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
77
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
78 Genomics Core Leuven,
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
79
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
80 Belgium
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
81
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
82
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
83 ----
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
84
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
85 **Example:**
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
86
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
87 The outcome of this tool will always be different.
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
88
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
89 ----
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
90
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
91 **Project links:**
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
92
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
93 https://github.com/GenomicsCoreLeuven/GBSX
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
94
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
95 ----
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
96
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
97 **Integrated by:**
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
98
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
99 Koen Herten
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
100
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
101 Genomics Core
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
102
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
103 Center for Human Genetics
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
104
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
105 UZ – KU Leuven
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
106
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
107 Herestraat 49 PO box 602
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
108
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
109 B-3000 Leuven, Belgium
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
110
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
111
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
112
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
113 If you use this tool in Galaxy, please cite:
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
114
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
115
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
116 </help>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
117 <citations>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
118 <citation type="doi">10.1186/s12859-015-0514-3</citation>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
119
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
120 <citation type="bibtex">@INPROCEEDINGS{
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
121 author = {Herten, Koen and Hestand, Matthew S. and Vermeesch, Joris R. and Van Houdt, Jeroen KJ},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
122 doi = {10.1186/s12859-015-0514-3},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
123 issn = {1471-2105},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
124 journal = {BMC Bioinformatics},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
125 number = {1},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
126 pages = {1–6},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
127 title = {GBSX: a toolkit for experimental design and demultiplexing genotyping by sequencing experiments},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
128 url = {http://dx.doi.org/10.1186/s12859-015-0514-3},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
129 volume = {16},
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
130 year = {2015}
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
131 }</citation>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
132 </citations>
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
133
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
134
29fc2bb7bc18 Uploaded gbsx_barcodeGenerator.xml
koen
parents:
diff changeset
135 </tool>