comparison macros.xml @ 0:ef5f8bbf7730 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/circos commit a41493893bdcbe330434db9c5851719012b62fa8
author iuc
date Wed, 09 Aug 2017 09:52:52 -0400
parents
children ae9994cf526f
comparison
equal deleted inserted replaced
-1:000000000000 0:ef5f8bbf7730
1 <?xml version="1.0"?>
2 <macros>
3 <token name="@WRAPPER_VERSION@">0.9-RC2</token>
4 <xml name="requirements">
5 <requirements>
6 <requirement type="package" version="2.2.3">libgd</requirement>
7 <requirement type="package" version="0.69.5">circos</requirement>
8 <requirement type="package" version="2.7">python</requirement>
9 <requirement type="package" version="0.6.4">bcbiogff</requirement>
10 <requirement type="package" version="1.70">biopython</requirement>
11 </requirements>
12 </xml>
13
14 <xml name="citations">
15 <citations>
16 <citation type="doi">10.1101/gr.092759.109</citation>
17 </citations>
18 </xml>
19
20 <xml name="circos_color"
21 token_label="Color"
22 token_name="color"
23 token_value="#000000"
24 token_help=""
25 >
26 <param label="@LABEL@" type="color" name="@NAME@" value="@VALUE@" help="@HELP@">
27 <sanitizer>
28 <valid initial="string.letters,string.digits">
29 <add value="#" />
30 </valid>
31 </sanitizer>
32 </param>
33 </xml>
34
35 <xml name="auto_color"
36 token_name="color"
37 token_label="Color">
38 <conditional name="@NAME@" label="@LABEL@">
39 <param name="@NAME@_select" type="select" label="@LABEL@">
40 <option value="automatic" selected="true">Automatic Selection</option>
41 <option value="manual">Manual Specification</option>
42 </param>
43 <when value="automatic">
44 </when>
45 <when value="manual">
46 <param name="@NAME@" label="@LABEL@" type="color" value="#000000">
47 <sanitizer>
48 <valid initial="string.letters,string.digits">
49 <add value="#" />
50 </valid>
51 </sanitizer>
52 </param>
53 </when>
54 </conditional>
55 </xml>
56
57 <xml name="brewer_scale"
58 token_name="color"
59 token_label="Color">
60 <param name="@NAME@" type="select" label="@LABEL@">
61 <option value="purples-13-seq">Sequential: Purples</option>
62 <option value="reds-13-seq">Sequential: Reds</option>
63 <option value="oranges-13-seq">Sequential: Oranges</option>
64 <option value="greens-13-seq">Sequential: Greens</option>
65 <option value="blues-13-seq">Sequential: Blues</option>
66 <option value="greys-13-seq">Sequential: Greys</option>
67
68 <option value="bugn-13-seq">Sequential: Blue - Green</option>
69 <option value="bupu-13-seq">Sequential: Blue - Purple</option>
70 <option value="gnbu-13-seq">Sequential: Green - Blue</option>
71 <option value="orrd-13-seq">Sequential: Orange - Red</option>
72 <option value="pubu-13-seq">Sequential: Purple - Blue</option>
73 <option value="pubugn-13-seq">Sequential: Purple - Blue - Green</option>
74 <option value="purd-13-seq">Sequential: Purple - Red</option>
75 <option value="rdpu-13-seq">Sequential: Red - Purple</option>
76 <option value="ylgn-13-seq">Sequential: Yellow - Green</option>
77 <option value="ylgnbu-13-seq">Sequential: Yellow - Green - Blue</option>
78 <option value="ylorbr-13-seq">Sequential: Yellow - Orange - Brown</option>
79 <option value="ylorrd-13-seq">Sequential: Yellow - Orange - Red</option>
80
81 <option value="brbg-15-div">Diverging: Brown - Blue Green</option>
82 <option value="piyg-15-div">Diverging: Pink - Yellow Green</option>
83 <option value="prgn-15-div">Diverging: Purple - Green</option>
84 <option value="puor-15-div">Diverging: Purple - Orange</option>
85 <option value="rdbu-15-div">Diverging: Red - Blue</option>
86 <option value="rdgy-15-div">Diverging: Red - Grey</option>
87 <option value="rdylbu-15-div">Diverging: Red - Yellow - Blue</option>
88 <option value="rdylgn-15-div">Diverging: Red - Yellow - Green</option>
89 <option value="spectral-15-div">Diverging: Spectral</option>
90
91 <option value="accent-8-qual">Qualitative: Accent</option>
92 <option value="dark2-8-qual">Qualitative: Dark2</option>
93 <option value="paired-12-qual">Qualitative: Paired</option>
94 <option value="pastel1-9-qual">Qualitative: Pastel1</option>
95 <option value="pastel2-8-qual">Qualitative: Pastel2</option>
96 <option value="set1-9-qual">Qualitative: Set1</option>
97 <option value="set2-8-qual">Qualitative: Set2</option>
98 <option value="set3-12-qual">Qualitative: Set3</option>
99 </param>
100 </xml>
101
102 <xml name="axes">
103 <section name="sec_axes" title="Axes">
104 <repeat name="axes" title="Axis">
105 <param name="y0" type="float" value="0.0" label="Inside Radius (y0)" help="This is relative to the subplot you are currently in."/>
106 <param name="y1" type="float" value="1" label="Outside Radius (y1)" help="This is relative to the subplot you are currently in."/>
107
108 <expand macro="circos_color"/>
109 <param name="thickness" type="integer" value="1" label="Thickness"/>
110 <param name="spacing" type="float" value="0.1" label="Spacing" help="Relative spacing between each concentric arc"/>
111 </repeat>
112 </section>
113 </xml>
114
115 <xml name="backgrounds">
116 <section name="sec_bkgs" title="Backgrounds">
117 <repeat name="backgrounds" title="Background">
118 <param name="y0" type="float" value="0.0" label="Inside Radius (y0)" help="This is relative to the subplot you are currently in."/>
119 <param name="y1" type="float" value="1" label="Outside Radius (y1)" help="This is relative to the subplot you are currently in."/>
120 <expand macro="circos_color"/>
121 </repeat>
122 </section>
123 </xml>
124
125 <xml name="rules">
126 <section name="sec_rule" title="Rules">
127 <repeat name="rules" title="Rule">
128 <repeat name="conditions" title="Conditions to Apply">
129 <conditional name="application">
130 <param name="application_select" type="select" label="Condition">
131 <option value="1">Apply to Every Point</option>
132 <option value="on">Check for presence/absence per chromosome</option>
133 <option value="pos">Based on numerical position</option>
134 <option value="value">Apply based on point value</option>
135 <option value="var">Apply based on GFF3 qualifier value (when available)</option>
136 </param>
137 <when value="1">
138 </when>
139 <when value="on">
140 <param name="on_genomes" type="text" label="Comma separated list of contig IDs"/>
141 </when>
142 <when value="pos">
143 <param name="pos_gt" type="float" label="Greater than this base" value="1000.0" help="Leave as zero to disable this test"/>
144 <param name="pos_lt" type="float" label="Less than this base" value="0.0" help="Leave as zero to disable this test"/>
145 </when>
146 <when value="value">
147 <param name="pos_gt" type="float" label="Points above this value" value="0.0" help="Leave as zero to disable this test"/>
148 <param name="pos_lt" type="float" label="Points below this value" value="0.0" help="Leave as zero to disable this test"/>
149 </when>
150 <when value="var">
151 <param name="varname" type="text" label="Qualifier name"
152 help="Set to the name of the qualifier in the GFF3 file you wish to compare against" />
153
154 <param name="cond_select" type="select" label="Condition">
155 <option value="eq">Equal to (string)</option>
156 <option value="ne">Not equal to (string)</option>
157 </param>
158
159 <param name="varvalue" type="text" label="Qualifier value to compare against"/>
160 </when>
161 </conditional>
162 </repeat>
163 <repeat name="actions" title="Actions to Apply">
164 <conditional name="action">
165 <param name="action_select" type="select" label="Action">
166 <option value="show">Change Visibility</option>
167 <option value="fill_color">Change Fill Color for all points</option>
168 <option value="fill_color_value">Change Fill Color based on Value</option>
169 <option value="color">Change Stroke Color</option>
170 <option value="color_value">Change Stroke Color based on Value</option>
171 </param>
172 <when value="show">
173 <param name="action_value" type="boolean" truevalue="yes" falsevalue="no" label="Show"/>
174 </when>
175 <when value="fill_color">
176 <expand macro="circos_color" name="action_value" label="Fill Color"/>
177 </when>
178 <when value="color">
179 <expand macro="circos_color" name="action_value" label="Stroke Color"/>
180 </when>
181 <when value="fill_color_value">
182 <expand macro="brewer_scale" name="action_value" label="Fill Color"/>
183 <param name="min_value" type="float" value="-1" label="Expected minimum value of dataset"/>
184 <param name="max_value" type="float" value="1" label="Expected maximum value of dataset"/>
185 <param name="invert" type="boolean" truevalue="True" falsevalue="False" label="Invert Color Scale" />
186 </when>
187 <when value="color_value">
188 <expand macro="brewer_scale" name="action_value" label="Stroke Color"/>
189 <param name="min_value" type="float" value="-1" label="Expected minimum value of dataset"/>
190 <param name="max_value" type="float" value="1" label="Expected maximum value of dataset"/>
191 <param name="invert" type="boolean" truevalue="True" falsevalue="False" label="Invert Color Scale" />
192 </when>
193 </conditional>
194 </repeat>
195 <param name="continue_flow" type="boolean" truevalue="flow = continue" falsevalue="" label="Continue flow"
196 help="Allow rules after this one to be applied in addition to this rule. E.g. if one rule modifies font size, and another font colour, with continued flow they could both be applied rather than whichever was encountered first."/>
197 </repeat>
198 </section>
199 </xml>
200
201 <xml name="linkrules">
202 <section name="sec_link_rule" title="Rules">
203 <repeat name="rules" title="Rule">
204 <repeat name="conditions" title="Conditions to Apply" help="Multiple conditions will be combined using AND">
205 <conditional name="application">
206 <param name="application_select" type="select" label="Condition">
207 <option value="always">True / Always Applied</option>
208 <option value="interchr">Interchromosomal</option>
209 <option value="intrachr">Intrachromosomal</option>
210 <option value="chr">Chromosome</option>
211 <option value="dist">Distance between sides</option>
212 <option value="start1">Start position Left</option>
213 <option value="end1">End Position Left</option>
214 <option value="pos1">Middle position Left</option>
215 <option value="size1">Size Left</option>
216 <option value="start2">Start position Right</option>
217 <option value="end2">End Position Right</option>
218 <option value="pos2">Middle position Right</option>
219 <option value="size2">Size Right</option>
220 <option value="rev1">Reversed Left (link end is reversed (e.g. start &gt; end) </option>
221 <option value="rev2">Reversed Right (link end is reversed (e.g. start &gt; end) </option>
222 <option value="inv">Inverted (link is inverted (i.e. one of its ends is reversed). If both ends are reversed, the link is not inverted )</option>
223 </param>
224 <when value="chr">
225 <expand macro="chromosome_comparison"/>
226 </when>
227 <when value="start1">
228 <expand macro="integer_comparison"/>
229 </when>
230 <when value="end1">
231 <expand macro="integer_comparison"/>
232 </when>
233 <when value="pos1">
234 <expand macro="integer_comparison"/>
235 </when>
236 <when value="size1">
237 <expand macro="integer_comparison"/>
238 </when>
239 <when value="start2">
240 <expand macro="integer_comparison"/>
241 </when>
242 <when value="end2">
243 <expand macro="integer_comparison"/>
244 </when>
245 <when value="pos2">
246 <expand macro="integer_comparison"/>
247 </when>
248 <when value="size2">
249 <expand macro="integer_comparison"/>
250 </when>
251 <when value="dist">
252 <expand macro="integer_comparison"/>
253 </when>
254 <when value="rev1"/>
255 <when value="rev2"/>
256 <when value="inv"/>
257 <when value="interchr"/>
258 <when value="intrachr"/>
259 <when value="always"/>
260 </conditional>
261 </repeat>
262 <repeat name="actions" title="Actions to Apply">
263 <conditional name="action">
264 <param name="action_select" type="select" label="Action">
265 <option value="show">Change Visibility</option>
266 <option value="color">Change Link Color</option>
267 <option value="thickness">Change Thickness</option>
268 <option value="z">Change Z-depth</option>
269 </param>
270 <when value="show">
271 <param name="action_value" type="boolean" label="Show" truevalue="yes" falsevalue="no"/>
272 </when>
273 <when value="color">
274 <conditional name="dynamic">
275 <param name="dynamic_select" type="select" label="Static / Dynamic Change">
276 <option value="static">Static: Change is always applied</option>
277 <option value="dynamic">Dynamic: Change is sometimes applied</option>
278 </param>
279 <when value="static">
280 <expand macro="circos_color" label="Link Color" name="action_value"/>
281 </when>
282 <when value="dynamic">
283 <expand macro="brewer_scale" label="Fill Color" name="action_value"/>
284 <param name="min_value" type="float" value="-1" label="Expected minimum value of dataset"/>
285 <param name="max_value" type="float" value="1" label="Expected maximum value of dataset"/>
286 <param name="invert" type="boolean" truevalue="True" falsevalue="False" label="Invert Color Scale" />
287 </when>
288 </conditional>
289 </when>
290 <when value="thickness">
291 <param name="action_value" type="integer" value="1" label="Thickness"/>
292 </when>
293 <when value="z">
294 <conditional name="dynamic">
295 <param name="dynamic_select" type="select" label="Static or Dynamic Z-Depth">
296 <option value="static">Static</option>
297 <option value="dynamic">Dynamic (based on value)</option>
298 </param>
299 <when value="static">
300 <param name="action_value" type="float" value="1" label="Z-depth" help="Datasets with a higher z-depth value are drawn on top of datasets with lower z value"/>
301 </when>
302 <when value="dynamic">
303 <param name="min_value" type="float" value="-1" label="Expected minimum value of dataset"/>
304 <param name="max_value" type="float" value="1" label="Expected maximum value of dataset"/>
305 <param name="invert" type="boolean" truevalue="True" falsevalue="False" label="Invert Z-Depth Mapping" />
306 </when>
307 </conditional>
308 </when>
309 </conditional>
310 </repeat>
311
312 <param name="continue_flow" type="boolean" label="Continue flow" truevalue="flow = continue" falsevalue="" help="Allow rules after this one to be applied in addition to this rule. E.g. if one rule modifies font size, and another font colour, with continued flow they could both be applied rather than whichever was encountered first." />
313 </repeat>
314 </section>
315 </xml>
316
317 <xml name="integer_comparison">
318 <conditional name="comparison" >
319 <param name="compare" type="select" label="Comparison">
320 <option value="lt">less than</option>
321 <option value="gt">greater than</option>
322 </param>
323 <when value="lt">
324 <param name="compval" value="0" type="integer" label="value"/>
325 </when>
326 <when value="gt">
327 <param name="compval" value="0" type="integer" label="value"/>
328 </when>
329 </conditional>
330 </xml>
331
332 <xml name="chromosome_comparison">
333 <conditional name="comparison" >
334 <param name="compare" type="select" label="Comparison">
335 <option value="on">on chromosome (either side)</option>
336 <option value="from">from chromosome</option>
337 <option value="to">to chromosome</option>
338 <option value="fromto">from-to chromosome</option>
339 <option value="between">between chromosomes</option>
340 </param>
341 <!-- TODO select chromosome from metadata/file column instead of text fields -->
342 <when value="on">
343 <param name="compval" value="chr1" type="text" label="Chromosome"/>
344 </when>
345 <when value="from">
346 <param name="compval" value="chr1" type="text" label="Chromosome"/>
347 </when>
348 <when value="to">
349 <param name="compval" value="chr1" type="text" label="Chromosome"/>
350 </when>
351 <when value="fromto">
352 <param name="compval" value="chr1" type="text" label="From Chromosome"/>
353 <param name="compval2" value="chr1" type="text" label="To Chromosome"/>
354 </when>
355 <when value="between">
356 <param name="compval" value="chr1" type="text" label="Chromosome"/>
357 <param name="compval2" value="chr1" type="text" label="Chromosome"/>
358 </when>
359 </conditional>
360 </xml>
361
362 </macros>