annotate hyphy_bgm.xml @ 2:f2c6ada85b41 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit f14f2bae2b27dc04e574803c7d4442a64cfe43e4"
author iuc
date Fri, 14 Feb 2020 16:43:36 -0500
parents cdfa1afd7cb0
children 1df765cc6bcb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bf97cacc1a55 "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"?>
2
f2c6ada85b41 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit f14f2bae2b27dc04e574803c7d4442a64cfe43e4"
iuc
parents: 1
diff changeset
2 <tool id="hyphy_bgm" name="HyPhy-BGM" version="@VERSION@+galaxy1">
0
bf97cacc1a55 "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>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
4 <macros>
bf97cacc1a55 "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>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
6 </macros>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
7 <expand macro="requirements"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
9 ln -s '$input_file' bgm_input.fa &&
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
10 ln -s '$input_nhx' bgm_input.nhx &&
2
f2c6ada85b41 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit f14f2bae2b27dc04e574803c7d4442a64cfe43e4"
iuc
parents: 1
diff changeset
11 hyphy bgm
0
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
12 --alignment ./bgm_input.fa
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
13 --tree ./bgm_input.nhx
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
14 --run_type $datatype.value
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
15 #if $datatype.value == "codon":
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
16 --code '$datatype.gencodeid'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
17 #end if
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
18 #if $datatype.value == "protein":
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
19 --baseline_model '$datatype.model'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
20 #end if
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
21 --branches '$branches'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
22 --chain '$chain_length'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
23 --burn_in '$burn_in'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
24 --samples '$samples'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
25 --parents '$parents'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
26 --min_subs '$min_subs'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
27 > '$bgm_log'
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
28 ]]></command>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
29 <inputs>
bf97cacc1a55 "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 FASTA file"/>
bf97cacc1a55 "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 newick file"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
32 <conditional name="datatype">
bf97cacc1a55 "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">
bf97cacc1a55 "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>
bf97cacc1a55 "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>
bf97cacc1a55 "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>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
37 </param>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
38 <when value="nucleotide"/>
bf97cacc1a55 "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">
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
40 <expand macro="substitution" />
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
41 </when>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
42 <when value="codon">
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
43 <expand macro="gencode" />
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
44 </when>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
45 </conditional>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
46 <expand macro="branches"/>
bf97cacc1a55 "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"/>
bf97cacc1a55 "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"/>
bf97cacc1a55 "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"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
50 <param name="parents" type="integer" value="1" min="1" max="3" label="Maximum number of parents allowed per node"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
51 <param name="min_subs" type="integer" value="1" min="1" max="100000" label="Minimum number of ubstitutions per site to be included in the analysis"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
52 </inputs>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
53 <outputs>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
54 <data name="bgm_log" format="txt"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
55 <data name="bgm_output" format="hyphy_results.json" from_work_dir="bgm_input.fa.BGM.json"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
56 </outputs>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
57 <tests>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
58 <test>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
59 <param name="input_file" ftype="fasta" value="bgm-in1.fa"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
60 <param name="input_nhx" ftype="nhx" value="bgm-in1.nhx"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
61 <output name="bgm_output" file="bgm-out1.json" compare="sim_size"/>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
62 </test>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
63 </tests>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
64 <help><![CDATA[
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
65 The Bayesian Graphical Model (BGM) method is a tool for detecting coevolutionary interactions between amino acid positions in a protein.
1
cdfa1afd7cb0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
66
cdfa1afd7cb0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
67 See the online documentation_ for more information.
cdfa1afd7cb0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
68
cdfa1afd7cb0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 533e8f97b4df382944ac8a31d98e04c9efeb6798"
iuc
parents: 0
diff changeset
69 .. _documentation: http://hyphy.org/methods/selection-methods/#bgm
0
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
70 ]]></help>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
71 <expand macro="citations">
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
72 <citation type="doi">10.1371/journal.pcbi.0030231</citation>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
73 </expand>
bf97cacc1a55 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hyphy/ commit 2c7a7ff8a55e7584e84335baa3159a63ce7a590c"
iuc
parents:
diff changeset
74 </tool>