annotate rnadistance.xml @ 3:415ee78476ab draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 3103ebed1a420c7d3415b67ef532ea579edf9faa
author rnateam
date Wed, 12 Jul 2017 14:26:40 -0400
parents 4286146cb3aa
children 7fc7a56750b9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
1 <tool id="viennarna_rnadistance" name="@EXECUTABLE@" version="@VERSION@.0">
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
2 <description>Calculate distance between secondary structures of two RNAs</description>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
3 <macros>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
4 <token name="@EXECUTABLE@">RNAdistance</token>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
5 <import>macros.xml</import>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
6 </macros>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
7 <expand macro="requirements" />
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
8 <expand macro="stdio" />
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
9 <expand macro="version_command" />
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
10 <command>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
11 <![CDATA[
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
12 RNAdistance < '$input' > '$outfile'
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
13 --distance=#echo ''.join(str($distance).split(','))#
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
14 --compare=$compare
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
15 $shapiro
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
16 $backtrack
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
17 #if $backtrack and str($compare)=="m"
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
18 && cat backtrack.file >> '$outfile'
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
19 #end if
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
20 ]]>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
21 </command>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
22 <inputs>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
23 <param name="input" type="data" format="*" label="Primary and secondary stuctures file"/>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
24 <param name="distance" type="select" multiple="true" display="checkboxes" label="Representation to calculate the distance / alignment option">
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
25 <option value="f" selected="true">full/tree</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
26 <option value="F">full/string</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
27 <option value="h">hit/tree</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
28 <option value="H">hit/string</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
29 <option value="w">weighted coarse/tree</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
30 <option value="W">weighted coarse/string</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
31 <option value="c">coarse/tree</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
32 <option value="C">coarse/string</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
33 <validator type="no_options" message="Please select at least one type."/>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
34 </param>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
35 <param name="compare" type="select" label="Comparison Option" help="-d">
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
36 <option value="p" selected="True">p: pairwise (1st with 2nd, 3rd with 4th, ...)</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
37 <option value="m">m: matrix (each with each, output in matrix form)</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
38 <option value="f" >f: first (1st with 2nd, 1st with 3rd, ...)</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
39 <option value="c">c: continuous (1st with 2nd, 2nd with 3rd, ...)</option>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
40 </param>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
41 <param argument="--shapiro" type="boolean" checked="false" truevalue="--shapiro" falsevalue="" label="Use cost matrix by Bruce Shapiro" help="--shapiro"/>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
42 <param argument="--backtrack" type="boolean" checked="false" truevalue="--backtrack" falsevalue="" label="Print an alignment" help="--backtrack"/>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
43 </inputs>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
44 <outputs>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
45 <data format="txt" name="outfile"/>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
46 </outputs>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
47 <tests>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
48 <test>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
49 <param name="input" value="rnadistance_input1.dbn"/>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
50 <output name="outfile" file="rnadistance_result1.txt"/>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
51 </test>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
52 </tests>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
53 <help>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
54 <![CDATA[
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
55 **RNAdistance**
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
56
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
57
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
58 -----
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
59
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
60 **Input format**
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
61
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
62 RNAdistance requires one input file with the following structure:
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
63 1st line: can be a comment line like in Fasta, begins with '>'
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
64 2nd line: sequence
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
65 3rd line: first secondary structure in dot-bracket notation
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
66 4th line: second secondary structure in dot-bracket notation
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
67 ...
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
68 nth line: another sequence
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
69 ...
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
70
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
71 Several different RNA secondary structures can be specified. The input has a Fasta-like structure but with secondary structure information.
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
72
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
73
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
74 ------
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
75
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
76 **Outputs**
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
77
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
78 * distance of the structures
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
79 * with the backtrack options it is possible to get alignment ouput
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
80
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
81
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
82 ]]>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
83 </help>
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
84 <expand macro="citations" />
4286146cb3aa planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
rnateam
parents:
diff changeset
85 </tool>