Mercurial > repos > rnateam > viennarna_rnacofold

comparison rnacofold.xml @ 0:f3d4656ed57c draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/vienna_rna commit 0065dafe7bbd382bb995b28cc4089c9e4f4eeeb9
author rnateam
date Tue, 06 Dec 2016 12:33:31 -0500
parents
children cb8201484ad8
comparison
equal deleted inserted replaced
-1:000000000000 0:f3d4656ed57c
1 <tool id="viennarna_rnacofold" name="@EXECUTABLE@" version="@VERSION@.0">
2 <description>Calculate secondary structures of two RNAs with dimerization</description>
3 <macros>
4 <token name="@EXECUTABLE@">RNAcofold</token>
5 <import>macros.xml</import>
6 </macros>
7 <expand macro="requirements" />
8 <expand macro="stdio" />
9 <expand macro="version_command" />
10 <command>
11 <![CDATA[
12 RNAcofold < '$input' > '$tabularFile'
13 -T$model_options.temperature -d$model_options.dangling
14 $general_options.noPS
15 $general_options.noconversion
16 $IDs.auto_id
17 #if str($IDs.id_prefix) <> "alignment"
18 --id-prefix='$IDs.id_prefix'
19 #end if
20 #if $IDs.id_digits <> 4
21 --id-digits=$IDs.id_digits
22 #end if
23 #if $IDs.id_start <> 1
24 --id-start=$IDs.id_start
25 #end if
26 #if str($constraints.constraintLocation.constraintSelector) == "fromFile"
27 --constraint='$constraints.constraintLocation.constraintsFile'
28 $constraints.constraintLocation.canonicalBPonly
29 $constraints.constraintLocation.enforceConstraint
30 #end if
31 $algorithm_options.allpf
32 #if len($algorithm_options.concfiles) == 1
33 #for $i in $algorithm_options.concfiles
34 --concfile='$i.concfile'
35 #end for
36 #end if
37 #if $algorithm_options.pf <> "-1"
38 --partfunc=$algorithm_options.pf
39 #end if
40 #if $algorithm_options.pfScale <> 1.07
41 --pfScale=$algorithm_options.pfScale
42 #end if
43 #if $algorithm_options.bppmThreshold <> 1e-5
44 --bppmThreshold=$algorithm_options.bppmThreshold
45 #end if
46 $algorithm_options.gquad
47 $model_options.notetra
48 $model_options.nolp
49 $model_options.nogu
50 $model_options.noclosinggu
51 #if $model_options.nsp
52 --nsp='$model_options.nsp'
53 #end if
54 #if $model_options.betaScale <> 1.0
55 --betaScale=$model_options.betaScale
56 #end if
57
58 ]]>
59 </command>
60 <inputs>
61 <param format="fasta" name="input" type="data" label="Fasta file"/>
62 <section name="general_options" title="General Options">
63 <param name="noPS" type="boolean" truevalue="" falsevalue="--noPS" checked="true" label="Produce postscript output" help="" argument="--noPS"/>
64 <param name="noconversion" type="boolean" truevalue="" falsevalue="--noconv" checked="true" label="Convert Thymine to Uracil (T -> U)" argument="--noconv" help="Avoids confusion with DNA sequences"/>
65 </section>
66 <section name="IDs" title="Naming Conventions">
67 <param name="auto_id"
68 type="boolean" truevalue="--auto-id" falsevalue="" checked="false"
69 label="Automatically generate an ID for each alignment."
70 help="If this flag is active, RNAalifold ignores any IDs retrieved from the input and automatically generates an ID for each alignment."
71 argument="--auto-id"/>
72 <param name="id_prefix"
73 type="text" value="alignment"
74 label="Prefix for automatically generated IDs (as used in output file names)"
75 help="If this parameter is set, each alignment will be prefixed with the provided string. Hence, the output files will obey the following naming scheme: 'prefix_xxxx_ss.ps' (secondary structure plot), 'prefix_xxxx_dp.ps' (dot−plot), 'prefix_xxxx_aln.ps' (annotated alignment), etc. where xxxx is the alignment number beginning with the second alignment in the input. Use this setting in conjunction with the −−continuous−ids flag to assign IDs beginning with the first input alignment."
76 argument="--id-prefix"/>
77 <param name="id_digits"
78 type="integer" value="4" min="1" max="18"
79 label="The number of digits of the counter in automatically generated alignment IDs"
80 help="When alignments IDs are automatically generated, they receive an increasing number, starting with 1. This number will always be left−padded by leading zeros, such that the number takes up a certain width. Using this parameter, the width can be specified to the users need. We allow numbers in the range [1:18]."
81 argument="--id-digits"/>
82 <param name="id_start"
83 type="integer" value="1" min="0"
84 label="First number in automatically generated alignment IDs"
85 help="When alignment IDs are automatically generated, they receive an increasing number, usually starting with 1. Using this parameter, the first number can be specified to the users requirements. Note: negative numbers are not allowed. Note: Setting this parameter implies continuous alignment IDs, i.e. it activates the −−continuous−ids flag.."
86 argument="--id-start"/>
87 </section>
88 <section name="model_options" title="Model Options" expanded="true">
89 <param name="temperature" type="float" value="37.0" label="temperature [°C]" help="(-T)"/>
90 <param name="dangling" type="select" label="How to treat dangling end energies" help="(-d)">
91 <option value="0">0: ignore dangling ends</option>
92 <option value="1">1: only unpaired bases can participate in at most one dangling end, this is the default for mfe folding but unsupported for the partition function folding</option>
93 <option value="2" selected="True">2: unpaired bases participate in all dangling ends</option>
94 <option value="3">3: mfe folding will allow coaxial stacking of adjacent helices in multi−loops.</option>
95 </param>
96 <param name="nolp" type="boolean" truevalue="" falsevalue="--noLP" checked="true" label="Allow lonely base-pairs" help="(--noLP)"/>
97 <param name="nogu" type="boolean" truevalue="" falsevalue="--noGU" checked="true" label="Allow GU pairing" help="--noGU"/>
98 <param name="noclosinggu" type="boolean" truevalue="" falsevalue="--noClosingGU" checked="true" label="Allow GU pairing at the ends" help="Allow pairing of G and U at the ends of helices. --noClosingGU"/>
99 <param name="notetra" type="boolean" truevalue="" falsevalue="--noTetra" checked="true" label="Allow stabilization for loops, hairpins etc." help=" Include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing. (--noTetra)"/>
100 <param name="nsp" type="text" value="" label="Allow other pairs in addition to the usual AU,GC,and GU pairs."
101 help="Its argument is a comma separated list of additionally allowed pairs. If the first character is '-' then AB will imply that AB and BA are allowed pairs. e.g. RNAfold -nsp -GA will allow GA and AG pairs. Nonstandard pairs are given 0 stacking energy."
102 argument="--nsp"/>
103 <param name="betaScale" type="float" value="1.0" label="Scaling of Boltzman factors"
104 help=" The argument provided with this option enables to scale the thermodynamic temperature used in the Boltzmann factors independently from the temperature used to scale the individual energy contributions of the loop types."
105 argument="--betaScale"/>
106 </section>
107 <section name="constraints" title="Structure constraints">
108 <conditional name="constraintLocation">
109 <param name="constraintSelector" type="select" label="Constraints">
110 <!-- <option value="fromInput">The constraints are included in the input file</option> -->
111 <option value="fromFile">The constraints are in a seperate file</option>
112 <option value="none" selected="true">Don't use constraints</option>
113 </param>
114 <!-- <when value="fromInput"></when> -->
115 <when value="none"></when>
116 <when value="fromFile">
117 <param name="constraintsFile" type="data" format="*" label="Constraints file" argument="--constraint"/>
118 <param argument="--canonicalBPonly" type="boolean" truevalue="--canonicalBPonly" falsevalue="" checked="false" label="Remove non-canonical base pairs from he structure constraint" />
119 <param argument="--enforceConstraint" type="boolean" truevalue="--enforceConstraint" falsevalue="" checked="false" label="Enforce base pair given by round brackets () in structure constraint" />
120 </when>
121 </conditional>
122 </section>
123 <section name="algorithm_options" title="Algorithm Options">
124 <param name="pf" type="select" label="Calculate partition function" help="Calculate the partition function and base pairing probability matrix in addition to the mfe structure. Default is calculation of mfe structure only." argument="-p">
125 <option value="-1" selected="true">None</option>
126 <option value="0">0: Deactivates the calculation of the pair probabilities, saving about 50% in runtime</option>
127 <option value="1" >1: Calculate the partition function and base pairing probability matrix</option>
128 </param>
129 <param name="allpf" type="boolean" checked="false" truevalue="--all_pf" falsevalue="" label="Calculate homo-dimers as well as A and B monomers" help="--all_pf"/>
130 <param argument="-c" type="boolean" checked="false" truevalue="-c" falsevalue="" label="Concentrations" help="In addition to everything listed under the -a option, read in initial monomer concentrations and compute the expected equilibrium concentrations of the 5 possible species (AB, AA, BB, A, B)."/>
131 <repeat name="concfiles" title="A file with initial concentrations for the two sequences" default="0" max="1" help="The table consits of arbitrary many lines with just two numbers (the concentration of sequence A and B). This option will automatically toggle the −c (and thus -a and --all_pf) options">
132 <param type="data" name="concfile" format="*" label="Concentrations file"/>
133 </repeat>
134 <param argument="--pfScale" type="float" value="1.07" label="Scaling factor" help="In the calculation of the pf use scale*mfe as an estimate for the ensemble free energy (used to avoid overflows). The default is 1.07, useful values are 1.0 to 1.2. Occasionally needed for long sequences." argumen="--pfScale"/>
135 <param argument="--bppmThreshold" type="float" value="1e-5" label="Threshold for base pair probabilities" help="By setting the threshold the base pair probabilities that are included in the output can be varied. By default only those exceeding 1e−5 in probability will be shown as squares in the dot plot. Changing the threshold to any other value allows for increase or decrease of data." argumen="--bppmThreshold"/>
136 <param argument="--gquad" type="boolean" truevalue="--gquad" falsevalue="" checked="false" label="G Quadruplex formation" help="take into account G Quadruplex formation"/>
137 </section>
138 </inputs>
139 <outputs>
140 <data format="txt" name="tabularFile"/>
141 <collection name="sequence_outputs" type="list" label="rna_eps outputs">
142 <discover_datasets pattern="(?P&lt;designation&gt;.+)_ss\.ps" ext="eps" />
143 </collection>
144 <collection name="matrix_outputs" type="list" label="rna_eps outputs">
145 <filter>pf is True</filter>
146 <discover_datasets pattern="(?P&lt;designation&gt;.+)_dp\.ps" ext="rna_eps" visible="true"/>
147 </collection>
148 </outputs>
149 <tests>
150 <test>
151 <param name="input" value="rnacofold_input1.fas"/>
152 <output name="out_file" file="rnacofold_result1.txt"/>
153 </test>
154 </tests>
155 <help>
156 <![CDATA[
157 **RNAcofold**
158
159
160 -----
161
162 **Input format**
163
164 RNAcofold requires one input file:
165
166 - Fasta file
167
168 Two different RNA sequences can be specified concatenated with the '&' character. The folding of the two sequences with each other will be calculated.
169
170
171 ------
172
173 **Outputs**
174
175 - Energies of the RNA sequences and the dimers
176 - Structure images
177 - Dot Plot Matrix images (if --partfunc is used)
178
179 ]]>
180 </help>
181 <expand macro="citations" />
182 </tool>