annotate rgclustal/rgClustalw.xml @ 3:9c4d943fbef7 draft default tip

Uploaded
author fubar
date Sun, 01 Dec 2013 20:07:58 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
1 <tool id="clustalw" name="ClustalW" version="0.2">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
2 <description>multiple sequence alignment program for DNA or proteins</description>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
3 <requirements>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
4 <requirement type="package" version="2.1">clustalw</requirement>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
5 </requirements>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
6 <command>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
7 #if ($range.mode=="part")
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
8 clustalw2 -infile=$input -outfile=$output -OUTORDER=$out_order -RANGE=$range.seq_range_start,$range.seq_range_end
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
9 #elif ($range.mode=="complete")
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
10 clustalw2 -infile=$input -outfile=$output -OUTORDER=$out_order
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
11 #end if
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
12 #if ($outcontrol.outform=="clustal")
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
13 -SEQNOS=$outcontrol.out_seqnos
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
14 #end if
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
15 #if ($outcontrol.outform=="phylip")
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
16 -OUTPUT=PHYLIP
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
17 #end if
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
18 #if ($outcontrol.outform=="fasta")
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
19 -OUTPUT=FASTA
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
20 #end if
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
21 -TYPE=$dnarna 1&gt;$outlog 2&gt;&amp;1
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
22 </command>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
23 <inputs>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
24 <page>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
25 <param format="fasta" name="input" type="data" label="Fasta File" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
26 <param name="outname" label="Name for output files to make it easy to remember what you did" type="text" size="50" value="Clustal_run" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
27 <param name="dnarna" type="select" label="Data Type">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
28 <option value="DNA" selected="True">DNA nucleotide sequences</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
29 <option value="PROTEIN">Protein sequences</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
30 </param>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
31 <conditional name="outcontrol">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
32 <param name="outform" type="select" label="Output alignment format">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
33 <option value="clustal" selected="True">Native Clustal output format</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
34 <option value="phylip">Phylip format</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
35 <option value="fasta">Fasta format</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
36 </param>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
37 <when value="fasta" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
38 <when value="phylip" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
39 <when value="clustal">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
40 <param name="out_seqnos" type="select" label="Show residue numbers in clustal format output">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
41 <option value="ON">yes</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
42 <option value="OFF" selected="true">no</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
43 </param>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
44 </when>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
45 </conditional>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
46 <param name="out_order" type="select" label="Output Order">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
47 <option value="ALIGNED">aligned</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
48 <option value="INPUT">same order as input file</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
49 </param>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
50
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
51 <conditional name="range">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
52 <param name="mode" type="select" label="Output complete alignment (or specify part to output)">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
53 <option value="complete">complete alignment</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
54 <option value="part">only part of the alignment</option>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
55 </param>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
56 <when value="complete">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
57 </when>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
58 <when value="part">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
59 <param name="seq_range_start" size="5" type="integer" value="1" label="start point" help="sequence range to write">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
60 </param>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
61 <param name="seq_range_end" size="5" type="integer" value="99999" label="end point" >
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
62 </param>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
63 </when>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
64 </conditional>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
65 </page>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
66 </inputs>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
67 <outputs>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
68 <data format="clustal" name="output" label="${outname}_output.${outcontrol.outform}">
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
69 <change_format>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
70 <when input="outcontrol.outform" value="phylip" format="phylip" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
71 <when input="outcontrol.outform" value="fasta" format="fasta" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
72 </change_format>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
73 </data>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
74 <data format="txt" name="outlog" label="${outname}_clustal_log.txt"/>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
75 </outputs>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
76 <tests>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
77 <test>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
78 <param name="input" value="rgClustal_testin.fasta" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
79 <param name = "outname" value="" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
80 <param name = "outform" value="fasta" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
81 <param name = "dnarna" value="DNA" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
82 <param name = "mode" value="complete" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
83 <param name = "out_order" value="ALIGNED" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
84 <output name="output" file="rgClustal_testout.fasta" ftype="fasta" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
85 <output name="output" file="rgClustal_testout.log" ftype="txt" lines_diff="5" />
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
86 </test>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
87 </tests>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
88 <help>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
89
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
90 **Note**
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
91
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
92 This tool allows you to run a multiple sequence alignment with ClustalW2 (see Clustsrc_) using the default options.
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
93
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
94 For a tutorial introduction, see ClustalW2_
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
95
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
96 You can align DNA or protein sequences in the input file which should be multiple sequences to be aligned in a fasta file
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
97
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
98 A log will be output to your history showing the output Clustal would normally write to standard output.
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
99
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
100 The alignments will appear as a clustal format file or optionally, as phylip or fasta format files in your history. If you choose fasta as
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
101 the output format, you can create a 'Logo' image using the Sequence Logo tool.
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
102
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
103 If Clustal format is chosen, you have the option of adding basepair counts to the output
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
104
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
105 A subsequence of the alignment can be output by setting the Output complete parameter to "Partial" and defining the offset and end of the subsequence to be output
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
106
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
107 ----
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
108
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
109 **Attribution**
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
110
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
111 Clustal attribution and associated documentation are available at Clustsrc_
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
112
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
113 The first iteration of this Galaxy wrapper was written by Hans-Rudolf Hotz - see Clustfirst_
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
114
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
115 It was modified by Ross Lazarus for the rgenetics project
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
116
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
117 This wrapper is now LGPL
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
118
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
119 .. _ClustalW2: http://www.ebi.ac.uk/2can/tutorials/protein/clustalw.html
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
120
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
121 .. _Clustsrc: http://www.clustal.org
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
122
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
123 .. _Clustfirst: http://lists.bx.psu.edu/pipermail/galaxy-dev/2010-November/003732.html
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
124
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
125 </help>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
126
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
127 </tool>
9c4d943fbef7 Uploaded
fubar
parents:
diff changeset
128