annotate mrbayes.xml @ 5:ed4fcc8c453a draft default tip

Uploaded
author anngomez
date Mon, 10 Dec 2012 09:27:00 -0500
parents ad8b097df80a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
1 <?xml version="1.0"?>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
2 <tool id="mrbayes" name="MrBayes">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
3 <description>with options and commands</description>
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
4 <command> mb $command_file > $outfile
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
5 ## print list of avaialble variables
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
6 #silent sys.stderr.write("\n \n \n ======== Cheetah template variables ========\n")
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
7 #for k,v in $searchList[2].items()
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
8 #silent sys.stderr.write(" %s = %s\n" % (str(k), str(v) ))
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
9 #end for
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
10 #silent sys.stderr.write("======== End of Cheetah template variables ========\n \n \n")
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
11 </command>
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
12 <inputs>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
13 <param name="data" type="data" format="nex" label="Nexus input file"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
14
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
15 <param name="filename" type="text" label="Output filename" size="10" value=""
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
16 help="Output files will be named this with .p, .t, .mcmc extensions. Use to avoid overwriting files when running repeated analyses on the same dataset." />
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
17
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
18 <param name="ngen" type="integer" label="&lt;hr&gt;Number of generations" value="10000" >
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
19 <validator type="in_range" min="1" max="inf" message="Must be greater than or equal to 1"/>
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
20 </param>
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
21 <param name="nchain" type="integer" label="Number of chains" value="2" >
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
22 <validator type="in_range" min="1" max="inf" message="Must be greater than or equal to 1"/>
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
23 </param>
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
24 <param name="nrun" type="integer" label="Number of runs" value="2" >
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
25 <validator type="in_range" min="1" max="inf" message="Must be greater than or equal to 1"/>
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
26 </param>
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
27
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
28 <param name="outgroup" type="text" label="&lt;hr&gt;Outgroup" size="10" value="1"
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
29 help="The name or number identifying one taxon from the data." />
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
30 <param name="model" type="select" label="Choose model">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
31 <sanitizer sanitize="False" />
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
32 <option value="lset nst=6" >GRT</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
33 <option value="lset nst=6; prset statefreqpr=fixed(equal)">SYM</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
34 <option value="lset nst=2" >HKY</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
35 <option value="lset nst=2; prset statefreqpr=fixed(equal)">K2P</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
36 <option value="lset nst=1" >F81</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
37 <option value="lset nst=1; prset statefreqpr=fixed(equal)">JC </option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
38 <option value="lset nst=mixed" >Mixed </option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
39 <help>Models are defined below and are only valid for nucleotide data.</help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
40 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
41 <param name="rates" type="select" label="Choose rates">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
42 <option value="equal"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
43 <option value="gamma"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
44 <option value="propinv"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
45 <option value="invgamma"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
46 <option value="adgamma"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
47 </param>
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
48 <param name="samplefreq" type="integer" label="&lt;hr&gt;Sample frequency" value="500" >
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
49 <validator type="in_range" min="1" max="inf" message="Must be greater than or equal to 1"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
50 <help>Frequency with which output it written to files." </help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
51 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
52 <param name="printfreq" type="integer" label="Print frequency" value="500" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
53 <validator type="in_range" min="1" max="inf" message="Must be greater than or equal to 1"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
54 <help>Frequency with which output is printed to the screen.</help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
55 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
56 <param name="burninfrac" type="float" label="Burn-in fraction" value="0.25">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
57 <validator type="in_range" min="0.01" max=".50" message="Must be between 0.01 and .50"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
58 <help>Fraction of samples to discard when summarizing. </help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
59 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
60 <param name="stoprule" type="select" label="Stop rule?" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
61 <option value="no">No</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
62 <option value="yes">Yes</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
63 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
64
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
65 <param name="sump" type="boolean" truevalue="sump;" falsevalue="" label="&lt;hr&gt;Include sump?"
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
66 help="Summarizes sampled parameter value."/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
67 <param name="sumt" type="boolean" truevalue="sumt;" falsevalue="" label="Include sumt?"
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
68 help="Summarizes the trees."/>
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
69 <param name="plot" type="boolean" truevalue="plot" falsevalue="" label="Include plot?"
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
70 help="Creates an x-y graph of the parameter over the course of the chain."/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
71
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
72 <param name="checkfreq" type="integer" label="&lt;hr&gt;Checkpoint frequency" value="100000" >
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
73 <validator type="in_range" min="100" max="inf" message="Must be greater than or equal to 100"/>
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
74 <help>Frequency with which checkpoints are written. Used for continuing analysis with append.</help>
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
75 </param>
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
76 <param name="append" type="boolean" truevalue="mcmcp append=yes" falsevalue="mcmcp append=no" label="Append to last checkpoint?"
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
77 help="Requires .ckp file (i.e. that number of generations > checkpoint frequency for previous analysis)." />
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
78
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
79 </inputs>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
80
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
81 <configfiles>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
82 <configfile name="command_file">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
83 begin mrbayes;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
84 set quitonerror=no;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
85 execute $data;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
86 outgroup $outgroup;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
87 $model;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
88 lset rates=$rates;
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
89 #if str($filename) != ""
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
90 mcmcp filename=$filename;
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
91 #end if#
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
92 mcmcp ngen=$ngen nrun=$nrun nchain=$nchain checkfreq=$checkfreq samplefreq=$samplefreq printfreq=$printfreq stoprule=$stoprule burninfrac=$burninfrac;
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
93 #if int($ngen) >= int($checkfreq)
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
94 $append;
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
95 #end if#
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
96 mcmc;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
97 $sump
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
98 $sumt
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
99 #if str($plot) == "plot"
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
100 plot;
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
101 #end if#
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
102 end;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
103 </configfile>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
104 </configfiles>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
105
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
106 <outputs>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
107 <data name="outfile" format="txt"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
108 </outputs>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
109
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
110 <requirements>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
111 <requirement version="3.2.1" type="binary">mb</requirement>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
112 </requirements>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
113 <help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
114
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
115 .. class:: warningmark
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
116
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
117 This tool takes as input a Nexus file (.nex), described here_, that should only contain a data block, without commands. If a command block exists in the file, it will be executed first, followed by the ones specified above.
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
118
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
119 .. _here: http://en.wikipedia.org/wiki/Nexus_file.
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
120
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
121 -----
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
122
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
123 **What it does**
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
124
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
125 MrBayes is a program for Bayesian inference and model choice across a wide range of phylogenetic and evolutionary models. MrBayes uses Markov chain Monte Carlo (MCMC) methods to estimate the posterior distribution of model parameters.
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
126
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
127 See the manual_ or the `command reference`_ for more information.
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
128
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
129 .. _manual: http://mrbayes.sourceforge.net/manual.php
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
130 .. _command reference: http://mrbayes.sourceforge.net/commref_mb3.2.pdf
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
131
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
132 -----
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
133
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
134 **Model Definitions**
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
135
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
136 Models are defined by the following MrBayes options::
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
137
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
138 GRT: lset nst=6;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
139 SYM: lset nst=6; prset statefreqpr=fixed(equal);
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
140 HKY: lset nst=2;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
141 K2P: lset nst=2; prset statefreqpr=fixed(equal);
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
142 F81: lset nst=1;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
143 JC: lset nst=1; prset statefreqpr=fixed(equal);
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
144 Mixed: lset nst=mixed;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
145
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
146 Each model makes different assumptions about nucelotide substitution rates and state frequencies.
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
147
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
148 The mixed model performs Markov chain sampling over the space of all possible reversible substitution models, by grouping the six rates in various combinations.
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
149
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
150 -----
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
151
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
152 .. class:: infomark
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
153
5
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
154 **Tip for repetitive analyses**
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
155
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
156 Note that running the same analysis on the same dataset in Galaxy will overwrite .p, .t, and .mcmc files for that dataset. This can be avoided by copying the dataset or re-uploading it, or by specifying a new filename.
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
157
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
158 .. class:: infomark
ed4fcc8c453a Uploaded
anngomez
parents: 4
diff changeset
159
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
160 **Tip for using append**
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
161
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
162 If you want to use the append functionality, all parameters will have to be identical to your initial analysis. The easiest way to ensure this is by using the blue "Run this job again" arrow on the dataset, and checking the additional append box. Note also that ngen will be the total number of generations, not the number of generations to add, so you should increase this value except if a run was interrupted. Selecting append while checkfreq > ngen will have no effect.
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
163 </help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
164 </tool>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
165