annotate rgWebLogo3.xml @ 1:a10f9ed463ae draft

Uploaded
author devteam
date Wed, 25 Feb 2015 11:00:37 -0500
parents 66253fc0a69b
children 76426785ae1c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="rgweblogo3" name="Sequence Logo" version="0.4">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
2 <description>generator for fasta (eg Clustal alignments)</description>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
1
a10f9ed463ae Uploaded
devteam
parents: 0
diff changeset
4 <requirement type="package" version="1.7.1">numpy</requirement>
0
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="3.3">weblogo</requirement>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
6 <requirement type="package" version="9.10">ghostscript</requirement>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
7 </requirements>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
8 <command interpreter="python">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
9 rgWebLogo3.py -F $outformat -s $size -i $input -o $output -t "$logoname" -c "$colours" -U "$units"
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
10 #if $range.mode == 'part'
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
11 -l "$range.seqstart" -u "$range.seqend"
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
12 #end if
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
13 </command>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
14 <inputs>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
15 <page>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
16 <param format="fasta" name="input" type="data" label="Fasta File" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
17 <param name="logoname" label="Title for output Sequence Logo" type="text" size="50" value="Galaxy-Rgenetics Sequence Logo" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
18 <param name="outformat" type="select" label="Output format for image (or text report)" >
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
19 <option value="png" selected="True">PNG screen quality</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
20 <option value="png_print">High quality printable PNG</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
21 <option value="pdf">PDF</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
22 <option value="jpeg">JPG</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
23 <option value="eps">EPS</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
24 <option value="txt">Text (shows the detailed calculations for each position - no image)</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
25 </param>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
26 <param name="units" type="select" label="Display Units"
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
27 help="What the height of each logo element depicts - eg bits of entropy (default)">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
28 <option value="bits" selected="True">Entropy (bits)</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
29 <option value="probability">Probability</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
30 <option value="nats">Nats</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
31 <option value="kT">kT</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
32 <option value="kJ/mol">kJ/mol</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
33 <option value="kcal/mol">kcal/mol</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
34 </param>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
35 <param name="colours" type="select" label="Colour scheme for output Sequence Logo"
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
36 help="Note that some of these only make sense for protein sequences!">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
37 <option value="auto" selected="True">Default automatic colour selection</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
38 <option value="base pairing">Base pairing</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
39 <option value="charge">Charge colours</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
40 <option value="chemistry">Chemistry colours</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
41 <option value="classic">Classical colours</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
42 <option value="hydrophobicity">Hydrophobicity</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
43 <option value="monochrome">monochrome</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
44 </param>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
45
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
46
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
47 <conditional name="range">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
48 <param name="mode" type="select" label="Include entire sequence (default) or specify a subsequence range to use">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
49 <option value="complete" selected="true">complete sequence</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
50 <option value="part">Only use a part of the sequence</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
51 </param>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
52 <when value="complete">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
53 </when>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
54 <when value="part">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
55 <param name="seqstart" size="5" type="integer" value="1" help="WARNING: Specifying indexes outside the sequence lengths will cause unpredictable but bad consequences!"
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
56 label="Index (eg 1=first letter) of the start of the sequence range to include in the logo">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
57 </param>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
58 <param name="seqend" size="5" type="integer" value="99999" label="Index (eg 75=75th letter) of the end of the sequence range to include in the logo" >
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
59 </param>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
60 </when>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
61 </conditional>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
62 <param name="size" type="select" label="Output weblogo size" >
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
63 <option value="large" selected="True">Large</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
64 <option value="medium">Medium</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
65 <option value="small">Small</option>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
66 </param>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
67 </page>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
68 </inputs>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
69 <outputs>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
70 <data format="pdf" name="output" label="${logoname}_output.${outformat}">
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
71 <change_format>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
72 <when input="outformat" value="png_print" format="png" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
73 <when input="outformat" value="png" format="png" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
74 <when input="outformat" value="jpeg" format="jpg" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
75 <when input="outformat" value="eps" format="eps" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
76 <when input="outformat" value="txt" format="txt" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
77 </change_format>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
78 </data>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
79 </outputs>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
80 <tests>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
81 <test>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
82 <param name="input" value="rgClustal_testout.fasta" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
83 <param name="logoname" value="Galaxy/Rgenetics weblogo" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
84 <param name="outformat" value="jpeg" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
85 <param name="mode" value="complete" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
86 <param name="size" value="medium" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
87 <param name="colours" value="auto" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
88 <param name="units" value="bits" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
89 <output name="output" file="rgWebLogo3_test.jpg" ftype="jpg" compare="sim_size" delta="10000" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
90 </test>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
91 <test>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
92 <param name="input" value="rgClustal_testout.fasta" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
93 <param name="logoname" value="Galaxy/Rgenetics weblogo" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
94 <param name="outformat" value="png" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
95 <param name="mode" value="complete" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
96 <param name="size" value="medium" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
97 <param name="colours" value="auto" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
98 <param name="units" value="probability" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
99 <output name="output" file="rgWebLogo3_test2.png" ftype="png" compare="sim_size" delta="10000" />
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
100 </test>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
101 </tests>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
102 <help>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
103
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
104 **Note**
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
105
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
106 This tool uses Weblogo3_ in Galaxy to generate a sequence logo. The input file must be a fasta file in your current history.
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
107
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
108 It is recommended for (eg) viewing multiple sequence alignments output from the clustalw tool - set the output to fasta and feed
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
109 it in to this tool.
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
110
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
111 A typical output looks like this
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
112
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
113 .. image:: ${static_path}/images/rgWebLogo3_test.jpg
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
114
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
115 ----
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
116
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
117 **Warning about input Fasta format files**
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
118
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
119 The Weblogo3 program used by this tool will fail if your fasta sequences are not all EXACTLY the same length. The tool will provide a warning
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
120 and refuse to call the weblogo3 executable if irregular length sequences are detected.
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
121
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
122 Fasta alignments from the companion ClustalW Galaxy tool will work but many other fasta files may cause this tool to fail - please do not file
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
123 a Galaxy bug report - this is a feature of the tool and a problem with your source data - not a tool error - please make certain all your fasta
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
124 sequences are the same length!
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
125
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
126 ----
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
127
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
128 **Attribution**
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
129
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
130 Weblogo attribution and associated documentation are available at Weblogo3_
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
131
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
132 This Galaxy wrapper was written by Ross Lazarus for the rgenetics project and the source code is licensed under the LGPL_ like other rgenetics artefacts
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
133
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
134 .. _Weblogo3: http://weblogo.berkeley.edu/
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
135
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
136 .. _LGPL: http://www.gnu.org/copyleft/lesser.html
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
137
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
138 </help>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
139
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
140 </tool>
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
141
66253fc0a69b Imported from capsule None
devteam
parents:
diff changeset
142