annotate rgweblogo/rgWebLogo3.xml @ 7:38ee0ae2f220 draft

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