annotate mrbayes.xml @ 4:ad8b097df80a draft

Added crude append functionality!
author anngomez
date Wed, 21 Nov 2012 11:27:56 -0500
parents 8741c342e8af
children ed4fcc8c453a
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
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
5 #silent sys.stderr.write("\n \n \n !!!! Cheetah Template Variables !!!!\n")
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
6 #for k,v in $searchList[2].items()
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
7 #silent sys.stderr.write(" %s = %s\n" % (str(k), str(v) ))
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
8 #end for
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
9 #silent sys.stderr.write("!!!! end-of-list !!!!\n \n \n")
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
10 </command>
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
11 <inputs>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
12 <param name="data" type="data" format="nex" label="Nexus input file"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
13
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
14 <param name="outgroup" type="text" label="Outgroup" size="10" value="1"
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
15 help="The name or number identifying one taxon from the data." />
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
16 <param name="model" type="select" label="Choose model">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
17 <sanitizer sanitize="False" />
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
18 <option value="lset nst=6" >GRT</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
19 <option value="lset nst=6; prset statefreqpr=fixed(equal)">SYM</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
20 <option value="lset nst=2" >HKY</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
21 <option value="lset nst=2; prset statefreqpr=fixed(equal)">K2P</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
22 <option value="lset nst=1" >F81</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
23 <option value="lset nst=1; prset statefreqpr=fixed(equal)">JC </option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
24 <option value="lset nst=mixed" >Mixed </option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
25 <help>Models are defined below and are only valid for nucleotide data.</help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
26 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
27 <param name="rates" type="select" label="Choose rates">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
28 <option value="equal"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
29 <option value="gamma"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
30 <option value="propinv"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
31 <option value="invgamma"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
32 <option value="adgamma"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
33 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
34 <param name="ngen" type="integer" label="Number of generations" value="1000" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
35 <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
36 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
37 <param name="nchain" type="integer" label="Number of chains" value="2" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
38 <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
39 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
40 <param name="nrun" type="integer" label="Number of runs" value="2" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
41 <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
42 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
43 <param name="checkfreq" type="integer" label="Checkpoint frequency" value="100000" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
44 <validator type="in_range" min="100" max="inf" message="Must be greater than or equal to 100"/>
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
45 <help>Frequency with which checkpoints are written. Used for continuing analysis with append.</help>
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
46 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
47 <param name="samplefreq" type="integer" label="Sample frequency" value="500" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
48 <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
49 <help>Frequency with which output it written to files." </help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
50 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
51 <param name="printfreq" type="integer" label="Print frequency" value="500" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
52 <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
53 <help>Frequency with which output is printed to the screen.</help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
54 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
55 <param name="burninfrac" type="float" label="Burn-in fraction" value="0.25">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
56 <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
57 <help>Fraction of samples to discard when summarizing. </help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
58 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
59 <param name="stoprule" type="select" label="Stop rule?" >
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
60 <option value="no">No</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
61 <option value="yes">Yes</option>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
62 </param>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
63
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
64 <param name="sump" type="boolean" truevalue="sump;" falsevalue="" label="Include sump?"
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
65 help="Summarizes sampled parameter value."/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
66 <param name="sumt" type="boolean" truevalue="sumt;" falsevalue="" label="Include sumt?"
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
67 help="Summarizes the trees."/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
68 <param name="plot" type="boolean" truevalue="plot;" falsevalue="" label="Include plot?"
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
69 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
70
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
71 <param name="append" type="boolean" truevalue="mcmcp append=yes" falsevalue="mcmcp append=no" label="Append to last checkpoint?"
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
72 help="Requires .ckp file (i.e. that ngen > checkfreq)." />
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
73
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
74 </inputs>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
75
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
76 <configfiles>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
77 <configfile name="command_file">
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
78 begin mrbayes;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
79 set quitonerror=no;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
80 execute $data;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
81 outgroup $outgroup;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
82 $model;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
83 lset rates=$rates;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
84 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
85 #if int($ngen) >= int($checkfreq)
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
86 $append;
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
87 #end if#
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
88 mcmc;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
89 $sump
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
90 $sumt
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
91 $plot
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
92 end;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
93 </configfile>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
94 </configfiles>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
95
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
96 <outputs>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
97 <data name="outfile" format="txt"/>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
98 </outputs>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
99
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
100 <requirements>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
101 <requirement version="3.2.1" type="binary">mb</requirement>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
102 </requirements>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
103 <help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
104
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
105 .. class:: warningmark
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
106
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
107 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
108
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
109 .. _here: http://en.wikipedia.org/wiki/Nexus_file.
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
110
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
111 -----
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
112
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
113 **What it does**
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
114
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
115 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
116
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
117 See the manual_ or the `command reference`_ for more information.
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
118
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
119 .. _manual: http://mrbayes.sourceforge.net/manual.php
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
120 .. _command reference: http://mrbayes.sourceforge.net/commref_mb3.2.pdf
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
121
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
122 -----
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
123
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
124 **Model Definitions**
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
125
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
126 Models are defined by the following MrBayes options::
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
127
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
128 GRT: lset nst=6;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
129 SYM: lset nst=6; prset statefreqpr=fixed(equal);
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
130 HKY: lset nst=2;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
131 K2P: lset nst=2; prset statefreqpr=fixed(equal);
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
132 F81: lset nst=1;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
133 JC: lset nst=1; prset statefreqpr=fixed(equal);
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
134 Mixed: lset nst=mixed;
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
135
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
136 Each model makes different assumptions about nucelotide substitution rates and state frequencies.
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
137
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
138 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
139
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
140 -----
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
141
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
142 .. class:: infomark
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
143
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
144 **Tip for using append**
3
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
145
4
ad8b097df80a Added crude append functionality!
anngomez
parents: 3
diff changeset
146 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
147 </help>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
148 </tool>
8741c342e8af Uploaded MrBayes wrapper for dynamic commands.
anngomez
parents:
diff changeset
149