annotate rgClustalw.xml @ 0:de3662385a52 draft

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