annotate hyphy_fade.xml @ 3:b959fd359a6b draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 6b2cd926797bb94fba9d0e319a2dbcff6ee37735"
author iuc
date Sun, 16 Feb 2020 00:02:23 -0500
parents f65e8fe7d5b8
children 16b4a3869bd5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
3
b959fd359a6b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 6b2cd926797bb94fba9d0e319a2dbcff6ee37735"
iuc
parents: 2
diff changeset
2 <tool id="hyphy_fade" name="HyPhy-FADE" version="@VERSION@+galaxy0">
0
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
3 <description>: FUBAR* Approach to Directional Evolution (*Fast
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
4 Unconstrained Bayesian Approximation)</description>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
5 <macros>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
6 <import>macros.xml</import>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
7 </macros>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
8 <expand macro="requirements"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
10 ln -s '$input_file' fade_input.fa &&
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
11 ln -s '$input_nhx' fade_input.nhx &&
2
f65e8fe7d5b8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit f14f2bae2b27dc04e574803c7d4442a64cfe43e4"
iuc
parents: 1
diff changeset
12 hyphy fade
0
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
13 --alignment ./fade_input.fa
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
14 --tree ./fade_input.nhx
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
15 --branches '$branches'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
16 --model '$model'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
17 --method '$posteriorEstimationMethod'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
18 --grid '$grid_points'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
19 --concentration_parameter '$concentration'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
20 #if $posteriorEstimationMethod != "Metropolis-Hastings"
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
21 --chains '$mcmc'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
22 --chain-length '$chain_length'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
23 --burn-in '$samples'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
24 --samples '$samples_per_chain'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
25 #end if
2
f65e8fe7d5b8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit f14f2bae2b27dc04e574803c7d4442a64cfe43e4"
iuc
parents: 1
diff changeset
26 --output '$fade_output'
0
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
27 > '$fade_log'
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
28 ]]></command>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
29 <inputs>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
30 <param name="input_file" type="data" format="fasta" label="Input amino acid FASTA file"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
31 <param name="input_nhx" type="data" format="nhx" label="Input rooted newick file"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
32 <expand macro="branches"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
33 <expand macro="substitution" />
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
34 <param name="grid_points" type="integer" value="20" min="5" max="50" label="Grid points"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
35 <param name="mcmc" type="integer" value="5" min="2" max="20" label="Number of MCMC chains"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
36 <param name="chain_length" type="integer" value="2000000" min="500000" max="50000000" label="Length of each chain"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
37 <param name="samples" type="integer" value="1000000" min="100000" max="1900000" label="Samples to use for burn-in"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
38 <param name="samples_per_chain" type="integer" value="100" min="50" max="1000000" label="Samples to draw from each chain"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
39 <param name="concentration" type="float" value="0.5" min="0.001" max="1" label="Concentration parameter of the Dirichlet prior"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
40 <expand macro="branches"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
41 <param name="posteriorEstimationMethod" type="select" label="Posterior estimation method">
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
42 <option value="Variational-Bayes">Metropolis-Hastings - Full
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
43 Metropolis-Hastings MCMC algorithm (slowest, original 2013
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
44 paper implementation)</option>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
45 <option value="Collapsed-Gibbs">Collapsed Gibbs - Collapsed Gibbs sampler
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
46 (intermediate speed)</option>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
47 <option value="Metropolis-Hastings">Variational Bayes - 0-th order Variational
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
48 Bayes approximations (fastest, recommended default)</option>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
49 </param>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
50 </inputs>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
51 <outputs>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
52 <data name="fade_log" format="txt"/>
2
f65e8fe7d5b8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit f14f2bae2b27dc04e574803c7d4442a64cfe43e4"
iuc
parents: 1
diff changeset
53 <data name="fade_output" format="hyphy_results.json" />
0
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
54 </outputs>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
55 <tests>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
56 <test>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
57 <param name="input_file" ftype="fasta" value="fade-in1.fa"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
58 <param name="input_nhx" ftype="nhx" value="fade-in1.nhx"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
59 <output name="fade_output" file="fade-out1.json" compare="sim_size"/>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
60 </test>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
61 </tests>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
62 <help><![CDATA[
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
63 FADE (FUBAR Approach to Directional Evolution) uses the same underlying algorithmic advances as impletented in FUBAR to apply Baysian MCMC accounting of parameter uncertiantiy to detect sites evolving under directional evolution in protien alignments.
1
da4192d32e10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
64
da4192d32e10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
65 See the online documentation_ for more information.
da4192d32e10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
66
da4192d32e10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
67 .. _documentation: http://hyphy.org/methods/selection-methods/#fade
0
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
68 ]]></help>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
69 <expand macro="citations">
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
70 <citation type="doi">10.1093/molbev/msv022</citation>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
71 </expand>
6164d9298db9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
72 </tool>