annotate drep_compare.xml @ 5:ffeabd4e2c1b draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit f940e776e4eba38a0a9c299c3675f59e2c1c7e7b
author iuc
date Mon, 06 Nov 2023 09:11:32 +0000
parents 7157accd23d0
children 9902c85117a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
1 <tool id="drep_compare" name="dRep compare" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@" python_template_version="3.5">
0
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
2 <description>compare a list of genomes</description>
1
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
3 <expand macro="biotools" />
0
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
4 <macros>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
5 <import>macros.xml</import>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
6 </macros>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
7 <expand macro="requirements" />
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
1
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
9 @PREPARE_GENOMES@
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
10 dRep compare outdir
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
11 @GENOMES@
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
12 @COMPARISON_CLUSTERING_OPTIONS@
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
13 @WARNING_OPTIONS@
0
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
14 ]]></command>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
15 <inputs>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
16 <expand macro="genomes"/>
1
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
17 <expand macro="comparison_clustering_options"/>
0
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
18 <expand macro="warning_options"/>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
19 <expand macro="select_outputs"/>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
20 </inputs>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
21 <outputs>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
22 <expand macro="common_outputs" />
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
23 </outputs>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
24 <tests>
1
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
25 <test expect_num_outputs="4">
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
26 <expand macro="test_string_inputs"/>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
27 <expand macro="test_default_comparison_clustering_options"/>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
28 <expand macro="test_default_warning_options"/>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
29 <expand macro="test_default_select_outputs"/>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
30 <expand macro="test_log_output">
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
31 <has_text text="dRep compare finished" />
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
32 </expand>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
33 </test>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
34 <test expect_num_outputs="4">
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
35 <expand macro="test_integer_inputs"/>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
36 <expand macro="test_default_comparison_clustering_options"/>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
37 <expand macro="test_default_warning_options"/>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
38 <expand macro="test_default_select_outputs"/>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
39 <expand macro="test_log_output">
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
40 <has_text text="dRep compare finished" />
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
41 </expand>
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
42 </test>
0
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
43 </tests>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
44 <help><![CDATA[
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
45 **dRep compare**
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
46
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
47 `dRep <https://drep.readthedocs.io/en/latest/overview.html>`_ performs rapid pair-wise comparison of genome sets.
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
48
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
49 `dRep compare <https://drep.readthedocs.io/en/latest/overview.html#genome-comparison>`_ can rapidly and accurately compare a list of genomes in a pair-wise manner. This allows identification of groups of organisms that share similar DNA content in terms of Average Nucleotide Identity (ANI).
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
50
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
51 dRep performs this in two steps:
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
52
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
53 - first with a rapid primary algorithm (Mash)
1
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
54 - second with a more sensitive algorithm (ANIm).
0
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
55
1
7157accd23d0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 0
diff changeset
56 We can't just use Mash because, while incredibly fast, it is not robust to genome incompletenss (see `Choosing parameters <https://drep.readthedocs.io/en/latest/choosing_parameters.html>`_ and `Module Descriptions <https://drep.readthedocs.io/en/latest/module_descriptions.html>`_) and only provides an “estimate” of ANI. ANIm is robust to genome incompleteness and is more accurate, but too slow to perform pair-wise comparisons of longer genome lists.
0
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
57
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
58 dRep first compares all genomes using Mash, and then only runs the secondary algorithm (ANIm or gANI) on sets of genomes that have at least 90% Mash ANI. This results in a great decrease in the number of (slow) secondary comparisons that need to be run while maintaining the sensitivity of ANIm.
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
59
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
60
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
61 **INPUTS**
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
62
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
63 - Genome sets in fasta format.
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
64
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
65
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
66 **OUTPUTS**
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
67
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
68 - `Figures <https://drep.readthedocs.io/en/latest/example_output.html#figures>`_ that show the relationship of the Genome inputs.
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
69 - `Warnings <https://drep.readthedocs.io/en/latest/example_output.html#warnings>`_ report two things: de-replicated genome similarity and secondary clusters that were almost different.
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
70
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
71
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
72 ]]></help>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
73 <expand macro="citations" />
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
74 </tool>