annotate rgClustalw.xml @ 1:973f9ca114fb draft

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