annotate hyphy_bgm.xml @ 33:ac3e2bd6ef2d draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 4bb2092ac089e709bdc0ec3c3680f47e17be509a"
author iuc
date Tue, 29 Mar 2022 23:58:38 +0000
parents 05499204cbce
children d162a1f8e495
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ebf951fda5a3 "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"?>
32
05499204cbce "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit e74f0c1ed183da674db365c3a6ce320b0c08d9bc"
iuc
parents: 31
diff changeset
2 <tool id="hyphy_bgm" name="HyPhy-BGM" version="@TOOL_VERSION@+galaxy2" profile="19.09">
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
3 <description>- Detecting coevolving sites via Bayesian graphical models</description>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
4 <macros>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
5 <import>macros.xml</import>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
6 </macros>
33
ac3e2bd6ef2d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 4bb2092ac089e709bdc0ec3c3680f47e17be509a"
iuc
parents: 32
diff changeset
7 <expand macro="bio_tools"/>
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
8 <expand macro="requirements"/>
ebf951fda5a3 "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[
23
dd69abea3146 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2742ee3b4e90f65352845265d2f85c4263e0eabb"
iuc
parents: 16
diff changeset
10 @SYMLINK_FILES@
26
9a4d1613c31d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2dd9bdc695433c217bbb7e11c1c0138245beb801"
iuc
parents: 25
diff changeset
11 ln -s '$bgm_output' ${input_file}.BGM.json &&
2
63b4ca9f0b3b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit f14f2bae2b27dc04e574803c7d4442a64cfe43e4"
iuc
parents: 1
diff changeset
12 hyphy bgm
26
9a4d1613c31d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2dd9bdc695433c217bbb7e11c1c0138245beb801"
iuc
parents: 25
diff changeset
13 --alignment $input_file
25
c28a0ba1b36a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 3908306ffa6f6cbc7b83303b2d4c581406d2fad9"
iuc
parents: 23
diff changeset
14 @INPUT_TREE@
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
15 --run_type $datatype.value
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
16 #if $datatype.value == "codon":
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
17 --code '$datatype.gencodeid'
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
18 #end if
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
19 #if $datatype.value == "protein":
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
20 --baseline_model '$datatype.model'
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
21 #end if
25
c28a0ba1b36a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 3908306ffa6f6cbc7b83303b2d4c581406d2fad9"
iuc
parents: 23
diff changeset
22 @branch_options@
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
23 --chain '$chain_length'
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
24 --burn_in '$burn_in'
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
25 --samples '$samples'
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
26 --parents '$parents'
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
27 --min_subs '$min_subs'
25
c28a0ba1b36a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 3908306ffa6f6cbc7b83303b2d4c581406d2fad9"
iuc
parents: 23
diff changeset
28 @ERRORS@
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
29 ]]></command>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
30 <inputs>
23
dd69abea3146 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2742ee3b4e90f65352845265d2f85c4263e0eabb"
iuc
parents: 16
diff changeset
31 <expand macro="inputs" />
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
32 <conditional name="datatype">
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
33 <param name="value" type="select" label="Type of data">
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
34 <option value="nucleotide">Nucleotide</option>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
35 <option value="amino-acid">Amino acid</option>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
36 <option value="codon">Codon</option>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
37 </param>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
38 <when value="nucleotide"/>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
39 <when value="amino-acid">
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
40 <expand macro="substitution" />
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
41 </when>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
42 <when value="codon">
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
43 <expand macro="gencode" />
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
44 </when>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
45 </conditional>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
46 <expand macro="branches"/>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
47 <param name="chain_length" type="integer" value="100000" min="0" max="1000000000" label="Length of MCMC chain"/>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
48 <param name="burn_in" type="integer" value="10000" min="0" max="1000000000" label="Number of samples to discard for burn-in"/>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
49 <param name="samples" type="integer" value="100" min="0" max="100" label="Number of steps to extract from chain sample"/>
5
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
50 <param argument="--max-parents" name="parents" type="integer" value="1" min="1" max="3" label="Maximum number of parents allowed per node" />
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
51 <param argument="--min-subs" name="min_subs" type="integer" value="1" min="1" max="100000" label="Minimum number of ubstitutions per site to be included in the analysis" />
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
52 </inputs>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
53 <outputs>
26
9a4d1613c31d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2dd9bdc695433c217bbb7e11c1c0138245beb801"
iuc
parents: 25
diff changeset
54 <data name="bgm_output" format="hyphy_results.json" />
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
55 </outputs>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
56 <tests>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
57 <test>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
58 <param name="input_file" ftype="fasta" value="bgm-in1.fa"/>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
59 <param name="input_nhx" ftype="nhx" value="bgm-in1.nhx"/>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
60 <output name="bgm_output" file="bgm-out1.json" compare="sim_size"/>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
61 </test>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
62 </tests>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
63 <help><![CDATA[
5
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
64
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
65 BGM : Bayesian Graphical Models
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
66 ===============================
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
67
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
68 What does this do?
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
69 ------------------
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
70
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
71 This tools identifies groups of sites in the alignments that experience substitutions along the same branches,
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
72 i.g. *co-evolve*.
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
73
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
74 Brief description
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
75 -----------------
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
76
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
77 GM (Bayesian Graphical Model) uses a maximum likelihood ancestral state
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
78 reconstruction to map substitution (non-synonymous only for coding data)
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
79 events to branches in the phylogeny and then analyzes the joint
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
80 distribution of the substitution map using a Bayesian graphical model
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
81 (network). Next, a Markov chain Monte Carlo analysis is used to generate
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
82 a random sample of network structures from the posterior distribution
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
83 given the data. Each node in the network represents a site in the
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
84 alignment, and links (edges) between nodes indicate high posterior
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
85 support for correlated substitutions at the two sites over time, which
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
86 implies coevolution.
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
87
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
88
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
89 Input
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
90 -----
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
91
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
92 1. A *FASTA* sequence alignment.
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
93 2. A phylogenetic tree in the *Newick* format
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
94
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
95 Note: the names of sequences in the alignment must match the names of the sequences in the tree.
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
96
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
97 Output
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
98 ------
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
99
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
100 A JSON file with analysis results (http://hyphy.org/resources/json-fields.pdf).
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
101
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
102 A custom visualization module for viewing these results is available (see http://vision.hyphy.org/BGM for an example)
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
103
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
104 Further reading
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
105 ---------------
1
3f67160aaafd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
106
5
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
107 http://hyphy.org/methods/selection-methods/#BGM
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
108
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
109
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
110 Tool options
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
111 ------------
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
112 ::
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
113
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
114 --branches Which branches should be tested for selection?
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
115 All [default] : test all branches
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
116
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
117 Internal : test only internal branches (suitable for
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
118 intra-host pathogen evolution for example, where terminal branches
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
119 may contain polymorphism data)
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
120
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
121 Leaves: test only terminal (leaf) branches
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
122
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
123 Unlabeled: if the Newick string is labeled using the {} notation,
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
124 test only branches without explicit labels
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
125 (see http://hyphy.org/tutorials/phylotree/)
1
3f67160aaafd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
126
5
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
127 --max-parents The maximum number of parents allowed per node, i.e. how many sites
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
128 can directly influence substitution patterns at another site
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
129 Increasing this number scales complexity nonlinearly
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
130 default value: 1
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
131
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
132 --min-subs The minium number of substitutions per site to include it in the analysis
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
133 Filter low complexity (too few substitution) sites
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
134 default value: 1
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
135
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
136 --chains How many MCMC chains to run (does not apply to Variational-Bayes)
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
137 default value: 5
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
138
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
139 --steps MCMC chain length (does not apply to Variational-Bayes)
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
140 default value: 100,000
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
141
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
142 --burn-in MCMC chain burn in (does not apply to Variational-Bayes)
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
143 default value: 10,000
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
144
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
145 --samples MCMC samples to draw (does not apply to Variational-Bayes)
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
146 default value: 100
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
147
45a0eca3ef44 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit ca299e9bbfc25f8e57b5001b8057f2b9e42d0df6"
iuc
parents: 3
diff changeset
148
0
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
149 ]]></help>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
150 <expand macro="citations">
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
151 <citation type="doi">10.1371/journal.pcbi.0030231</citation>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
152 </expand>
ebf951fda5a3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
153 </tool>