annotate antarna.xml @ 5:7d563f8ea2bc draft

Uploaded
author rnateam
date Thu, 30 Apr 2015 10:00:21 -0400
parents 8f06bf451780
children e452d01258b8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
e2b843294290 Uploaded
rnateam
parents:
diff changeset
1 <tool id="antarna" name="antaRNA" version="1.1">
e2b843294290 Uploaded
rnateam
parents:
diff changeset
2 <description>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
3 Ant Colony Optimized RNA Sequence Design
e2b843294290 Uploaded
rnateam
parents:
diff changeset
4 </description>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
5 <requirements>
3
9f698c95cf2b Uploaded
rnateam
parents: 2
diff changeset
6 <requirement type="package" version="2.2.12">pkiss</requirement>
9f698c95cf2b Uploaded
rnateam
parents: 2
diff changeset
7 <requirement type="package" version="3.2.5">rnashapes</requirement>
5
7d563f8ea2bc Uploaded
rnateam
parents: 4
diff changeset
8 <requirement type="package" version="1.8">numpy</requirement>
1
e2b843294290 Uploaded
rnateam
parents:
diff changeset
9 </requirements>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
10 <stdio>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
11 <exit_code level="fatal" range="1:"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
12 </stdio>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
13 <version_command>python antaRNA.py --version</version_command>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
14 <command interpreter="python"><![CDATA[antaRNA.py
e2b843294290 Uploaded
rnateam
parents:
diff changeset
15 #if $Cstr and $Cstr is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
16 -Cstr "$Cstr"
e2b843294290 Uploaded
rnateam
parents:
diff changeset
17 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
18
e2b843294290 Uploaded
rnateam
parents:
diff changeset
19 #if $tGC and $tGC is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
20 -tGC $tGC
e2b843294290 Uploaded
rnateam
parents:
diff changeset
21 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
22
e2b843294290 Uploaded
rnateam
parents:
diff changeset
23 #if $n and $n is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
24 -n $n
e2b843294290 Uploaded
rnateam
parents:
diff changeset
25 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
26 $GU
e2b843294290 Uploaded
rnateam
parents:
diff changeset
27
e2b843294290 Uploaded
rnateam
parents:
diff changeset
28 #if $s and $s is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
29 -s $s
e2b843294290 Uploaded
rnateam
parents:
diff changeset
30 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
31
e2b843294290 Uploaded
rnateam
parents:
diff changeset
32 #if $ip and $ip is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
33 -ip $ip
e2b843294290 Uploaded
rnateam
parents:
diff changeset
34 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
35
e2b843294290 Uploaded
rnateam
parents:
diff changeset
36 #if $r and $r is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
37 -r $r
e2b843294290 Uploaded
rnateam
parents:
diff changeset
38 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
39
e2b843294290 Uploaded
rnateam
parents:
diff changeset
40 #if $CC and $CC is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
41 -CC $CC
e2b843294290 Uploaded
rnateam
parents:
diff changeset
42 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
43
e2b843294290 Uploaded
rnateam
parents:
diff changeset
44 #if $aTC and $aTC is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
45 -aTC $aTC
e2b843294290 Uploaded
rnateam
parents:
diff changeset
46 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
47 $p
e2b843294290 Uploaded
rnateam
parents:
diff changeset
48 $pkPar
e2b843294290 Uploaded
rnateam
parents:
diff changeset
49
e2b843294290 Uploaded
rnateam
parents:
diff changeset
50 #if $strategy and $strategy is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
51 --strategy $strategy
e2b843294290 Uploaded
rnateam
parents:
diff changeset
52 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
53
e2b843294290 Uploaded
rnateam
parents:
diff changeset
54 #if $tGCmax and $tGCmax is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
55 -tGCmax $tGCmax
e2b843294290 Uploaded
rnateam
parents:
diff changeset
56 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
57
e2b843294290 Uploaded
rnateam
parents:
diff changeset
58 #if $tGCvar and $tGCvar is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
59 -tGCvar $tGCvar
e2b843294290 Uploaded
rnateam
parents:
diff changeset
60 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
61
e2b843294290 Uploaded
rnateam
parents:
diff changeset
62 #if $t and $t is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
63 -t $t
e2b843294290 Uploaded
rnateam
parents:
diff changeset
64 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
65
e2b843294290 Uploaded
rnateam
parents:
diff changeset
66 #if $P and $P is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
67 -P $P
e2b843294290 Uploaded
rnateam
parents:
diff changeset
68 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
69
e2b843294290 Uploaded
rnateam
parents:
diff changeset
70 #if $of and $of is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
71 -of $of
e2b843294290 Uploaded
rnateam
parents:
diff changeset
72 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
73
e2b843294290 Uploaded
rnateam
parents:
diff changeset
74 #if $Cseq and $Cseq is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
75 -Cseq $Cseq
e2b843294290 Uploaded
rnateam
parents:
diff changeset
76 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
77
e2b843294290 Uploaded
rnateam
parents:
diff changeset
78 #if $l and $l is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
79 -l $l
e2b843294290 Uploaded
rnateam
parents:
diff changeset
80 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
81
e2b843294290 Uploaded
rnateam
parents:
diff changeset
82 #if $name and $name is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
83 --name $name
e2b843294290 Uploaded
rnateam
parents:
diff changeset
84 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
85
e2b843294290 Uploaded
rnateam
parents:
diff changeset
86 #if $a and $a is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
87 -a $a
e2b843294290 Uploaded
rnateam
parents:
diff changeset
88 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
89
e2b843294290 Uploaded
rnateam
parents:
diff changeset
90 #if $b and $b is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
91 -b $b
e2b843294290 Uploaded
rnateam
parents:
diff changeset
92 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
93
e2b843294290 Uploaded
rnateam
parents:
diff changeset
94 #if $er and $er is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
95 -er $er
e2b843294290 Uploaded
rnateam
parents:
diff changeset
96 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
97
e2b843294290 Uploaded
rnateam
parents:
diff changeset
98 #if $Cstrw and $Cstrw is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
99 -Cstrw $Cstrw
e2b843294290 Uploaded
rnateam
parents:
diff changeset
100 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
101
e2b843294290 Uploaded
rnateam
parents:
diff changeset
102 #if $Cgcw and $Cgcw is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
103 -Cgcw $Cgcw
e2b843294290 Uploaded
rnateam
parents:
diff changeset
104 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
105
e2b843294290 Uploaded
rnateam
parents:
diff changeset
106 #if $Cseqw and $Cseqw is not None:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
107 -Cseqw $Cseqw
e2b843294290 Uploaded
rnateam
parents:
diff changeset
108 #end if
e2b843294290 Uploaded
rnateam
parents:
diff changeset
109 $v
e2b843294290 Uploaded
rnateam
parents:
diff changeset
110 $ov
e2b843294290 Uploaded
rnateam
parents:
diff changeset
111 > $default]]></command>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
112 <inputs>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
113 <param label="Structure constraint using RNA dotbracket notation with fuzzy block constraint. (-Cstr)" name="Cstr" type="text"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
114 <param label="Objective target GC content in [0,1]. (-tGC)" name="tGC" type="float" value="0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
115 <param label="Number of sequences which shall be produced. (-n)" name="n" type="integer" value="0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
116 <param checked="false" label="Allowing GU base pairs. (-GU)" name="GU" type="boolean" truevalue="-GU" falsevalue=""/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
117 <param default="none" label="Provides a seed value for the used pseudo random number generator. (-s)" name="s" type="text"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
118 <param default="s" label="Select the improving method. h=hierarchical, s=score_based. (-ip)" name="ip" type="text"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
119 <param label="Amount of maximal terrain resets, until the best solution is retuned as solution. (-r)" name="r" type="integer" value="5"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
120 <param label="Delimits the convergence count criterion for a reset. (-CC)" name="CC" type="integer" value="130"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
121 <param label="Delimits the amount of internal ants for termination convergence criterion for a reset. (-aTC)" name="aTC" type="integer" value="50"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
122 <param checked="false" label="Switch to pseudoknot based prediction using pKiss. Check the pseudoknot parameter usage!!! (-p)" name="p" type="boolean" truevalue="-p" falsevalue=""/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
123 <param checked="false" label="Enable optimized parameters for the usage of pseudo knots (Further parameter input ignored). (-pkPar)" name="pkPar" type="boolean" truevalue="-pkPar" falsevalue=""/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
124 <param default="A" label="Defining the pKiss folding strategy. (--strategy)" name="strategy" type="text"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
125 <param label="Provides a maximum tGC value [0,1] for the case of uniform distribution sampling. The regular tGC value serves as minimum value. (-tGCmax)" name="tGCmax" type="float" value="-1.0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
126 <param label="Provides a tGC variance (sigma square) for the case of normal distribution sampling. The regular tGC value serves as expectation value (mu). (-tGCvar)" name="tGCvar" type="float" value="-1.0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
127 <param label="Provides a temperature for the folding algorithms. (-t)" name="t" type="float" value="37.0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
128 <param default="" label="Changes the energy parameterfile of RNAfold. If using this explicitly, please provide a suitable energy file delivered by RNAfold. (-P)" name="P" type="text"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
129 <param default="STDOUT" label="Provide a path and an output file, e.g. &quot;/path/to/the/target_file&quot;. (-of)" name="of" type="text"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
130 <param default="" label="Sequence constraint using RNA nucleotide alphabet {A,C,G,U} and wild-card &quot;N&quot;. (-Cseq)" name="Cseq" type="text"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
131 <param label="Sets the level of allowed influence of sequence constraint on the structure constraint [0:no influence; 3:extensive influence]. (-l)" name="l" type="integer" value="1"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
132 <param default="antaRNA_" label="Defines a name which is used in the sequence output. (--name)" name="name" type="text"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
133 <param label="Sets alpha, probability weight for terrain path influence. [0,1] (-a)" name="a" type="float" value="1.0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
134 <param label="Sets beta, probability weight for terrain pheromone influence. [0,1] (-b)" name="b" type="float" value="1.0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
135 <param label="Pheromone evaporation rate. (-er)" name="er" type="float" value="0.2"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
136 <param label="Structure constraint quality weighting factor. [0,1] (-Cstrw)" name="Cstrw" type="float" value="0.5"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
137 <param label="GC content constraint quality weighting factor. [0,1] (-Cgcw)" name="Cgcw" type="float" value="5.0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
138 <param label="Sequence constraint quality weighting factor. [0,1] (-Cseqw)" name="Cseqw" type="float" value="1.0"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
139 <param checked="false" label="Displayes intermediate output. (-v)" name="v" type="boolean" truevalue="-v" falsevalue=""/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
140 <param checked="false" label="Prints additional output to the headers of the produced sequences. (-ov)" name="ov" type="boolean" truevalue="-ov" falsevalue=""/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
141 </inputs>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
142 <outputs>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
143 <data format="txt" hidden="false" name="default"/>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
144 </outputs>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
145 <help><![CDATA[
e2b843294290 Uploaded
rnateam
parents:
diff changeset
146 .
e2b843294290 Uploaded
rnateam
parents:
diff changeset
147
e2b843294290 Uploaded
rnateam
parents:
diff changeset
148 ===========================
e2b843294290 Uploaded
rnateam
parents:
diff changeset
149 antaRNA - ant assembled RNA
e2b843294290 Uploaded
rnateam
parents:
diff changeset
150 ===========================
e2b843294290 Uploaded
rnateam
parents:
diff changeset
151
e2b843294290 Uploaded
rnateam
parents:
diff changeset
152 - antaRNA uses the VIENNNA RNA Package
e2b843294290 Uploaded
rnateam
parents:
diff changeset
153 - specifically it uses RNAfold and RNAdistance to calculate energies of and distances between secondary structures (version 2.1.x)
e2b843294290 Uploaded
rnateam
parents:
diff changeset
154 - for the parametrization of antaRNA the version 2.1.3 of the ViennaRNA package was used
e2b843294290 Uploaded
rnateam
parents:
diff changeset
155
e2b843294290 Uploaded
rnateam
parents:
diff changeset
156
e2b843294290 Uploaded
rnateam
parents:
diff changeset
157 - For questions and remarks please feel free to contact us at http://www.bioinf.uni-freiburg.de/
e2b843294290 Uploaded
rnateam
parents:
diff changeset
158
e2b843294290 Uploaded
rnateam
parents:
diff changeset
159 Example calls:
e2b843294290 Uploaded
rnateam
parents:
diff changeset
160
e2b843294290 Uploaded
rnateam
parents:
diff changeset
161 - python antaRNA.py --Cstr "...(((...)))..." --tGC 0.5 -n 2
e2b843294290 Uploaded
rnateam
parents:
diff changeset
162 - python antaRNA.py --Cstr ".........AAA(((...)))AAA........." --tGC 0.5 -n 10 --output_file /path/to/antaRNA_TESTRUN -ov
e2b843294290 Uploaded
rnateam
parents:
diff changeset
163 - python antaRNA.py --Cstr "BBBBB....AAA(((...)))AAA....BBBBB" --Cseq "NNNNANNNNNCNNNNNNNNNNNGNNNNNNUNNN" --tGC 0.5 -n 10
e2b843294290 Uploaded
rnateam
parents:
diff changeset
164 ]]></help>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
165 </tool>
e2b843294290 Uploaded
rnateam
parents:
diff changeset
166