annotate BSseeker2/galaxy/bs_seeker2_wrapper.xml @ 1:8b26adf64adc draft default tip

V2.0.5
author weilong-guo
date Tue, 05 Nov 2013 01:55:39 -0500
parents e6df770c0e58
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
weilong-guo
parents: 0
diff changeset
1 <tool id="bs_seeker_wrapper" name="BS-Seeker2" version="2.0.0">
weilong-guo
parents: 0
diff changeset
2 <requirements><requirement type='package'>bs_seeker2</requirement></requirements>
weilong-guo
parents: 0
diff changeset
3 <description>Versatile aligner for bisulfite sequencing data</description>
weilong-guo
parents: 0
diff changeset
4 <command interpreter="python">
weilong-guo
parents: 0
diff changeset
5 bs_seeker2_wrapper.py
weilong-guo
parents: 0
diff changeset
6 ### define exec path
weilong-guo
parents: 0
diff changeset
7 ### --exec-path "/u/home/galaxy/galaxy/GalaxyTools/bin"
weilong-guo
parents: 0
diff changeset
8 ### [Please change the following path to your local directory]
weilong-guo
parents: 0
diff changeset
9 --exec-path "/Users/weilong/Documents/program/BSseeker2"
weilong-guo
parents: 0
diff changeset
10 ### output
weilong-guo
parents: 0
diff changeset
11 --align--output $align_output
weilong-guo
parents: 0
diff changeset
12 --call_methylation--wig $call_methylation_wig
weilong-guo
parents: 0
diff changeset
13 --call_methylation--CGmap $call_methylation_CGmap
weilong-guo
parents: 0
diff changeset
14 --call_methylation--ATCGmap $call_methylation_ATCGmap
weilong-guo
parents: 0
diff changeset
15 --call_methylation--txt
weilong-guo
parents: 0
diff changeset
16
weilong-guo
parents: 0
diff changeset
17 #if $singlePaired.sPaired == "paired"
weilong-guo
parents: 0
diff changeset
18 --align--input_1 $input1
weilong-guo
parents: 0
diff changeset
19 --align--input_2 $singlePaired.input2
weilong-guo
parents: 0
diff changeset
20 #end if
weilong-guo
parents: 0
diff changeset
21
weilong-guo
parents: 0
diff changeset
22
weilong-guo
parents: 0
diff changeset
23 ### aligner
weilong-guo
parents: 0
diff changeset
24 --align--aligner ${choosealigner.aligner}
weilong-guo
parents: 0
diff changeset
25 #if $choosealigner.aligner == "bowtie2"
weilong-guo
parents: 0
diff changeset
26 #if $choosealigner.mode_type == "local"
weilong-guo
parents: 0
diff changeset
27 --align--bt2--local
weilong-guo
parents: 0
diff changeset
28 #else
weilong-guo
parents: 0
diff changeset
29 --align--bt2--end-to-end
weilong-guo
parents: 0
diff changeset
30 #end if
weilong-guo
parents: 0
diff changeset
31 #end if
weilong-guo
parents: 0
diff changeset
32
weilong-guo
parents: 0
diff changeset
33 ### Index from history or built-in
weilong-guo
parents: 0
diff changeset
34 #if $choosealigner.rrbsFragments.refGenomeSource.genomeSource == "history"
weilong-guo
parents: 0
diff changeset
35 --build--file ${choosealigner.rrbsFragments.refGenomeSource.ownFile}
weilong-guo
parents: 0
diff changeset
36 --build--aligner ${choosealigner.aligner}
weilong-guo
parents: 0
diff changeset
37 --align-g ${choosealigner.rrbsFragments.refGenomeSource.ownFile}
weilong-guo
parents: 0
diff changeset
38 --align--db ${choosealigner.rrbsFragments.refGenomeSource.ownFile}
weilong-guo
parents: 0
diff changeset
39 #else if $choosealigner.rrbsFragments.refGenomeSource.genomeSource == "indexed"
weilong-guo
parents: 0
diff changeset
40 --align--db ${choosealigner.rrbsFragments.refGenomeSource.index.fields.path}
weilong-guo
parents: 0
diff changeset
41 --align-g ${choosealigner.rrbsFragments.refGenomeSource.index.fields.path}/${choosealigner.rrbsFragments.refGenomeSource.index.fields.dbkey}.fa
weilong-guo
parents: 0
diff changeset
42
weilong-guo
parents: 0
diff changeset
43 #end if
weilong-guo
parents: 0
diff changeset
44
weilong-guo
parents: 0
diff changeset
45 ### RRBS or WGBS
weilong-guo
parents: 0
diff changeset
46 #if $choosealigner.rrbsFragments.Fragmented == "Yes"
weilong-guo
parents: 0
diff changeset
47 #if $choosealigner.rrbsFragments.refGenomeSource.genomeSource == "history"
weilong-guo
parents: 0
diff changeset
48 --build--rrbs
weilong-guo
parents: 0
diff changeset
49 --build--low ${choosealigner.rrbsFragments.lowerBound}
weilong-guo
parents: 0
diff changeset
50 --build--up ${choosealigner.rrbsFragments.upperBound}
weilong-guo
parents: 0
diff changeset
51 #end if
weilong-guo
parents: 0
diff changeset
52 --align--rrbs
weilong-guo
parents: 0
diff changeset
53 --align--low ${choosealigner.rrbsFragments.lowerBound}
weilong-guo
parents: 0
diff changeset
54 --align--up ${choosealigner.rrbsFragments.upperBound}
weilong-guo
parents: 0
diff changeset
55 #end if
weilong-guo
parents: 0
diff changeset
56
weilong-guo
parents: 0
diff changeset
57
weilong-guo
parents: 0
diff changeset
58
weilong-guo
parents: 0
diff changeset
59 ### Inputs
weilong-guo
parents: 0
diff changeset
60 #if $singlePaired.sPaired == "single"
weilong-guo
parents: 0
diff changeset
61 --align-i $input1
weilong-guo
parents: 0
diff changeset
62 #end if
weilong-guo
parents: 0
diff changeset
63
weilong-guo
parents: 0
diff changeset
64 ### Library type
weilong-guo
parents: 0
diff changeset
65 --align-t $tag
weilong-guo
parents: 0
diff changeset
66
weilong-guo
parents: 0
diff changeset
67 ### other general options
weilong-guo
parents: 0
diff changeset
68 #if $sParams.sSettingsType == "preSet"
weilong-guo
parents: 0
diff changeset
69 --align--start_base 1
weilong-guo
parents: 0
diff changeset
70 --align--end_base 200
weilong-guo
parents: 0
diff changeset
71 --align--mis 4
weilong-guo
parents: 0
diff changeset
72 #end if
weilong-guo
parents: 0
diff changeset
73
weilong-guo
parents: 0
diff changeset
74 ### adapter information
weilong-guo
parents: 0
diff changeset
75 #if $adapterInfo.useAdapter == "Yes"
weilong-guo
parents: 0
diff changeset
76 --align--adapter ${adapterInfo.adapter_file}
weilong-guo
parents: 0
diff changeset
77 #end if
weilong-guo
parents: 0
diff changeset
78
weilong-guo
parents: 0
diff changeset
79 #if $sParams.sSettingsType == "full"
weilong-guo
parents: 0
diff changeset
80 --align--start_base ${sParams.start_base}
weilong-guo
parents: 0
diff changeset
81 --align--end_base ${sParams.end_base}
weilong-guo
parents: 0
diff changeset
82 --align--mis ${sParams.num_mismatch}
weilong-guo
parents: 0
diff changeset
83 #end if
weilong-guo
parents: 0
diff changeset
84
weilong-guo
parents: 0
diff changeset
85 </command>
weilong-guo
parents: 0
diff changeset
86 <inputs>
weilong-guo
parents: 0
diff changeset
87 <param format="fastq,fasta,qseq" name="input1" type="data" label="Input your read file" help="reads file in fastq, qseq or fasta format" />
weilong-guo
parents: 0
diff changeset
88 <conditional name="singlePaired">
weilong-guo
parents: 0
diff changeset
89 <param name="sPaired" type="select" label="Is this library mate-paired?">
weilong-guo
parents: 0
diff changeset
90 <option value="single">Single-end</option>
weilong-guo
parents: 0
diff changeset
91 <option value="paired">Paired-end</option>
weilong-guo
parents: 0
diff changeset
92 </param>
weilong-guo
parents: 0
diff changeset
93 <when value="paired">
weilong-guo
parents: 0
diff changeset
94 <param format="fastq,fasta,qseq" name="input2" type="data" label="Input your read file 2" help="reads in fastq, qseq or fasta format" />
weilong-guo
parents: 0
diff changeset
95 <param name="min_ins_distance" type="integer" value="-1" label=" Minimum insert size for valid paired-end alignments" />
weilong-guo
parents: 0
diff changeset
96 <param name="max_ins_distance" type="integer" value="400" label="Maximum insert size for valid paired-end alignments" />
weilong-guo
parents: 0
diff changeset
97 </when>
weilong-guo
parents: 0
diff changeset
98 </conditional>
weilong-guo
parents: 0
diff changeset
99 <param name="tag" type="select" label="Type of libraries">
weilong-guo
parents: 0
diff changeset
100 <option value="N">directional libraries</option>
weilong-guo
parents: 0
diff changeset
101 <option value="Y">undirectional libraries</option>
weilong-guo
parents: 0
diff changeset
102 </param>
weilong-guo
parents: 0
diff changeset
103 <conditional name="choosealigner">
weilong-guo
parents: 0
diff changeset
104 <param name="aligner" type="select" label="Short reads aligner">
weilong-guo
parents: 0
diff changeset
105 <option value="bowtie">bowtie</option>
weilong-guo
parents: 0
diff changeset
106 <option value="bowtie2">bowtie2</option>
weilong-guo
parents: 0
diff changeset
107 </param>
weilong-guo
parents: 0
diff changeset
108 <when value="bowtie">
weilong-guo
parents: 0
diff changeset
109 <conditional name="rrbsFragments">
weilong-guo
parents: 0
diff changeset
110 <param name="Fragmented" type="select" label="RRBS-seq reads" help="">
weilong-guo
parents: 0
diff changeset
111 <option value="No">No</option>
weilong-guo
parents: 0
diff changeset
112 <option value="Yes">Yes</option>
weilong-guo
parents: 0
diff changeset
113 </param>
weilong-guo
parents: 0
diff changeset
114 <when value="Yes">
weilong-guo
parents: 0
diff changeset
115 <param name="lowerBound" type="integer" value="40" label="The lower bound for RRBS fragments" help="Default: 40" />
weilong-guo
parents: 0
diff changeset
116 <param name="upperBound" type="integer" value="500" label="The upper bound for RRBS fragments" help="Default: 500" />
weilong-guo
parents: 0
diff changeset
117 <conditional name="refGenomeSource">
weilong-guo
parents: 0
diff changeset
118 <param name="genomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="">
weilong-guo
parents: 0
diff changeset
119 <option value="indexed">Use a built-in index</option>
weilong-guo
parents: 0
diff changeset
120 <option value="history">Use one from the history</option>
weilong-guo
parents: 0
diff changeset
121 </param>
weilong-guo
parents: 0
diff changeset
122 <when value="indexed">
weilong-guo
parents: 0
diff changeset
123 <param name="index" type="select" label="Select a reference genome (RRBS, bowtie)">
weilong-guo
parents: 0
diff changeset
124 <options from_data_table="bs_seeker2_indexes_RRBS_bowtie">
weilong-guo
parents: 0
diff changeset
125 <filter type="sort_by" column="2"/>
weilong-guo
parents: 0
diff changeset
126 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
weilong-guo
parents: 0
diff changeset
127 </options>
weilong-guo
parents: 0
diff changeset
128 </param>
weilong-guo
parents: 0
diff changeset
129 </when>
weilong-guo
parents: 0
diff changeset
130 <when value="history">
weilong-guo
parents: 0
diff changeset
131 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select the reference genome" />
weilong-guo
parents: 0
diff changeset
132 </when>
weilong-guo
parents: 0
diff changeset
133 </conditional>
weilong-guo
parents: 0
diff changeset
134 </when>
weilong-guo
parents: 0
diff changeset
135 <when value="No">
weilong-guo
parents: 0
diff changeset
136 <conditional name="refGenomeSource">
weilong-guo
parents: 0
diff changeset
137 <param name="genomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="">
weilong-guo
parents: 0
diff changeset
138 <option value="indexed">Use a built-in index</option>
weilong-guo
parents: 0
diff changeset
139 <option value="history">Use one from the history</option>
weilong-guo
parents: 0
diff changeset
140 </param>
weilong-guo
parents: 0
diff changeset
141 <when value="indexed">
weilong-guo
parents: 0
diff changeset
142 <param name="index" type="select" label="Select a reference genome (WGBS, bowtie)">
weilong-guo
parents: 0
diff changeset
143 <options from_data_table="bs_seeker2_indexes_WGBS_bowtie">
weilong-guo
parents: 0
diff changeset
144 <filter type="sort_by" column="2"/>
weilong-guo
parents: 0
diff changeset
145 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
weilong-guo
parents: 0
diff changeset
146 </options>
weilong-guo
parents: 0
diff changeset
147 </param>
weilong-guo
parents: 0
diff changeset
148 </when>
weilong-guo
parents: 0
diff changeset
149 <when value="history">
weilong-guo
parents: 0
diff changeset
150 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select the reference genome" />
weilong-guo
parents: 0
diff changeset
151 </when>
weilong-guo
parents: 0
diff changeset
152 </conditional>
weilong-guo
parents: 0
diff changeset
153 </when>
weilong-guo
parents: 0
diff changeset
154 </conditional>
weilong-guo
parents: 0
diff changeset
155 </when>
weilong-guo
parents: 0
diff changeset
156
weilong-guo
parents: 0
diff changeset
157 <when value="bowtie2">
weilong-guo
parents: 0
diff changeset
158 <conditional name="rrbsFragments">
weilong-guo
parents: 0
diff changeset
159 <param name="Fragmented" type="select" label="RRBS-seq reads" help="">
weilong-guo
parents: 0
diff changeset
160 <option value="No">No</option>
weilong-guo
parents: 0
diff changeset
161 <option value="Yes">Yes</option>
weilong-guo
parents: 0
diff changeset
162 </param>
weilong-guo
parents: 0
diff changeset
163 <when value="Yes">
weilong-guo
parents: 0
diff changeset
164 <param name="lowerBound" type="integer" value="40" label="The lower bound for RRBS fragments" help="Default: 40" />
weilong-guo
parents: 0
diff changeset
165 <param name="upperBound" type="integer" value="500" label="The upper bound for RRBS fragments" help="Default: 500" />
weilong-guo
parents: 0
diff changeset
166 <conditional name="refGenomeSource">
weilong-guo
parents: 0
diff changeset
167 <param name="genomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="">
weilong-guo
parents: 0
diff changeset
168 <option value="indexed">Use a built-in index</option>
weilong-guo
parents: 0
diff changeset
169 <option value="history">Use one from the history</option>
weilong-guo
parents: 0
diff changeset
170 </param>
weilong-guo
parents: 0
diff changeset
171 <when value="indexed">
weilong-guo
parents: 0
diff changeset
172 <param name="index" type="select" label="Select a reference genome (RRBS, bowtie2)">
weilong-guo
parents: 0
diff changeset
173 <options from_data_table="bs_seeker2_indexes_RRBS_bowtie2">
weilong-guo
parents: 0
diff changeset
174 <filter type="sort_by" column="2"/>
weilong-guo
parents: 0
diff changeset
175 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
weilong-guo
parents: 0
diff changeset
176 </options>
weilong-guo
parents: 0
diff changeset
177 </param>
weilong-guo
parents: 0
diff changeset
178 </when>
weilong-guo
parents: 0
diff changeset
179 <when value="history">
weilong-guo
parents: 0
diff changeset
180 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select the reference genome" />
weilong-guo
parents: 0
diff changeset
181 </when>
weilong-guo
parents: 0
diff changeset
182 </conditional>
weilong-guo
parents: 0
diff changeset
183 </when>
weilong-guo
parents: 0
diff changeset
184 <when value="No">
weilong-guo
parents: 0
diff changeset
185 <conditional name="refGenomeSource">
weilong-guo
parents: 0
diff changeset
186 <param name="genomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="">
weilong-guo
parents: 0
diff changeset
187 <option value="indexed">Use a built-in index</option>
weilong-guo
parents: 0
diff changeset
188 <option value="history">Use one from the history</option>
weilong-guo
parents: 0
diff changeset
189 </param>
weilong-guo
parents: 0
diff changeset
190 <when value="indexed">
weilong-guo
parents: 0
diff changeset
191 <param name="index" type="select" label="Select a reference genome (WGBS, bowtie2)">
weilong-guo
parents: 0
diff changeset
192 <options from_data_table="bs_seeker2_indexes_WGBS_bowtie2">
weilong-guo
parents: 0
diff changeset
193 <filter type="sort_by" column="2"/>
weilong-guo
parents: 0
diff changeset
194 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
weilong-guo
parents: 0
diff changeset
195 </options>
weilong-guo
parents: 0
diff changeset
196 </param>
weilong-guo
parents: 0
diff changeset
197 </when>
weilong-guo
parents: 0
diff changeset
198 <when value="history">
weilong-guo
parents: 0
diff changeset
199 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select the reference genome" />
weilong-guo
parents: 0
diff changeset
200 </when>
weilong-guo
parents: 0
diff changeset
201 </conditional>
weilong-guo
parents: 0
diff changeset
202 </when>
weilong-guo
parents: 0
diff changeset
203 </conditional>
weilong-guo
parents: 0
diff changeset
204
weilong-guo
parents: 0
diff changeset
205
weilong-guo
parents: 0
diff changeset
206 <conditional name="mode_type">
weilong-guo
parents: 0
diff changeset
207 <param name="mode" type="select" label="Select the mode of Bowtie2">
weilong-guo
parents: 0
diff changeset
208 <option value="local" selected="true"> local alignment </option>
weilong-guo
parents: 0
diff changeset
209 <option value="end_to_end" > end-to-end alignment </option>
weilong-guo
parents: 0
diff changeset
210 </param>
weilong-guo
parents: 0
diff changeset
211 </conditional>
weilong-guo
parents: 0
diff changeset
212 </when>
weilong-guo
parents: 0
diff changeset
213 </conditional>
weilong-guo
parents: 0
diff changeset
214 <conditional name="adapterInfo">
weilong-guo
parents: 0
diff changeset
215 <param name="useAdapter" type="select" label="adapter sequence">
weilong-guo
parents: 0
diff changeset
216 <option value="noAdapter">No</option>
weilong-guo
parents: 0
diff changeset
217 <option value="withAdapter">Yes</option>
weilong-guo
parents: 0
diff changeset
218 </param>
weilong-guo
parents: 0
diff changeset
219 <when value="withAdapter">
weilong-guo
parents: 0
diff changeset
220 <param format="txt" name="adapter_file" type="data" label="Input file of your adaptor sequences" help="Input text file of your adaptor sequences" />
weilong-guo
parents: 0
diff changeset
221 </when>
weilong-guo
parents: 0
diff changeset
222 </conditional>
weilong-guo
parents: 0
diff changeset
223
weilong-guo
parents: 0
diff changeset
224 <conditional name="sParams">
weilong-guo
parents: 0
diff changeset
225 <param name="sSettingsType" type="select" label="BS Seeker2 settings to use" help="You can use the default settings or set customer values for the BS Seeker2 parameters.">
weilong-guo
parents: 0
diff changeset
226 <option value="preSet">User Defaults</option>
weilong-guo
parents: 0
diff changeset
227 <option value="full">Full parameter list</option>
weilong-guo
parents: 0
diff changeset
228 </param>
weilong-guo
parents: 0
diff changeset
229 <when value="preSet" />
weilong-guo
parents: 0
diff changeset
230 <when value="full">
weilong-guo
parents: 0
diff changeset
231 <param name="start_base" type="integer" value="1" label="The start base of the read to be mapped" help="" />
weilong-guo
parents: 0
diff changeset
232 <param name="end_base" type="integer" value="200" label="The end base of the read to be mapped" help="" />
weilong-guo
parents: 0
diff changeset
233
weilong-guo
parents: 0
diff changeset
234 <param name="num_mismatch" type="integer" value="4" label="Number of mismatches" help="(INT) Default: 4" />
weilong-guo
parents: 0
diff changeset
235 </when>
weilong-guo
parents: 0
diff changeset
236 </conditional>
weilong-guo
parents: 0
diff changeset
237
weilong-guo
parents: 0
diff changeset
238 </inputs>
weilong-guo
parents: 0
diff changeset
239
weilong-guo
parents: 0
diff changeset
240 <outputs>
weilong-guo
parents: 0
diff changeset
241 <data format="bam" name="align_output" label="BAM Alignments"> </data>
weilong-guo
parents: 0
diff changeset
242 <data format="wig" name="call_methylation_wig" label="Methylation Levels"> </data>
weilong-guo
parents: 0
diff changeset
243 <data format="tabular" name="call_methylation_CGmap" label="CGmap file"> </data>
weilong-guo
parents: 0
diff changeset
244 <data format="tabular" name="call_methylation_ATCGmap" label="ATCGmap file"> </data>
weilong-guo
parents: 0
diff changeset
245
weilong-guo
parents: 0
diff changeset
246 </outputs>
weilong-guo
parents: 0
diff changeset
247 <help>
weilong-guo
parents: 0
diff changeset
248 **What it does**
weilong-guo
parents: 0
diff changeset
249
weilong-guo
parents: 0
diff changeset
250 BS-Seeker2 is a seamlessly pipeline for mapping bisulfite sequencing data and generating detailed DNA methylome. BS-Seeker2 improves mappability by using local alignment, and is tailored for RRBS library by building special index, with higher efficiency and accuracy. This is the Galaxy version of BS-Seeker2.
weilong-guo
parents: 0
diff changeset
251
weilong-guo
parents: 0
diff changeset
252 ------
weilong-guo
parents: 0
diff changeset
253
weilong-guo
parents: 0
diff changeset
254 **Resources**
weilong-guo
parents: 0
diff changeset
255
weilong-guo
parents: 0
diff changeset
256 The homepage for BS-Seeker2 is http://pellegrini.mcdb.ucla.edu/BS_Seeker2/.
weilong-guo
parents: 0
diff changeset
257
weilong-guo
parents: 0
diff changeset
258 For more information of BS-Seeker2, please refer to https://github.com/BSSeeker/BSseeker2.
weilong-guo
parents: 0
diff changeset
259
weilong-guo
parents: 0
diff changeset
260 ------
weilong-guo
parents: 0
diff changeset
261
weilong-guo
parents: 0
diff changeset
262 **Example**
weilong-guo
parents: 0
diff changeset
263
weilong-guo
parents: 0
diff changeset
264 - Adapter file::
weilong-guo
parents: 0
diff changeset
265
weilong-guo
parents: 0
diff changeset
266 AGATCGGAAGAGCACACGTC
weilong-guo
parents: 0
diff changeset
267
weilong-guo
parents: 0
diff changeset
268
weilong-guo
parents: 0
diff changeset
269 </help>
weilong-guo
parents: 0
diff changeset
270 </tool>