annotate drep_compare.xml @ 10:db55f98c31ac draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 802d7fe606623d900fd0d5de157e87166c0b7e84
author iuc
date Wed, 07 May 2025 11:00:56 +0000
parents a77aa8570964
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
dfe6041879b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit bf3d3fb4a7c0ad2c6942955783bf15cda7754b28
iuc
parents: 2
diff changeset
1 <tool id="drep_compare" name="dRep compare" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
0
1db0ba55d411 "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>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
3 <macros>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
5 </macros>
6
dfe6041879b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit bf3d3fb4a7c0ad2c6942955783bf15cda7754b28
iuc
parents: 2
diff changeset
6 <expand macro="biotools" />
dfe6041879b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit bf3d3fb4a7c0ad2c6942955783bf15cda7754b28
iuc
parents: 2
diff changeset
7 <expand macro="requirements" />
0
1db0ba55d411 "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[
7
a77aa8570964 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 620124793ed18545728d07cfd8592065bc5c6c2d
iuc
parents: 6
diff changeset
9 @PREPARE_GENOMES@
a77aa8570964 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 620124793ed18545728d07cfd8592065bc5c6c2d
iuc
parents: 6
diff changeset
10 dRep
a77aa8570964 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 620124793ed18545728d07cfd8592065bc5c6c2d
iuc
parents: 6
diff changeset
11 compare
a77aa8570964 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 620124793ed18545728d07cfd8592065bc5c6c2d
iuc
parents: 6
diff changeset
12 outdir
a77aa8570964 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 620124793ed18545728d07cfd8592065bc5c6c2d
iuc
parents: 6
diff changeset
13 @GENOMES@
a77aa8570964 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 620124793ed18545728d07cfd8592065bc5c6c2d
iuc
parents: 6
diff changeset
14 @COMPARISON_CLUSTERING_OPTIONS@
a77aa8570964 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 620124793ed18545728d07cfd8592065bc5c6c2d
iuc
parents: 6
diff changeset
15 @WARNING_OPTIONS@
a77aa8570964 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 620124793ed18545728d07cfd8592065bc5c6c2d
iuc
parents: 6
diff changeset
16 --processors \${GALAXY_SLOTS:-1}
0
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
17 ]]></command>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
18 <inputs>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
19 <expand macro="genomes"/>
2
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
20 <expand macro="comparison_clustering_options"/>
0
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
21 <expand macro="warning_options"/>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
22 <expand macro="select_outputs"/>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
23 </inputs>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
24 <outputs>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
25 <expand macro="common_outputs" />
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
26 </outputs>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
27 <tests>
2
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
28 <test expect_num_outputs="4">
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
29 <expand macro="test_string_inputs"/>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
30 <expand macro="test_default_comparison_clustering_options"/>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
31 <expand macro="test_default_warning_options"/>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
32 <expand macro="test_default_select_outputs"/>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
33 <expand macro="test_log_output">
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
34 <has_text text="dRep compare finished" />
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
35 </expand>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
36 </test>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
37 <test expect_num_outputs="4">
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
38 <expand macro="test_integer_inputs"/>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
39 <expand macro="test_default_comparison_clustering_options"/>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
40 <expand macro="test_default_warning_options"/>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
41 <expand macro="test_default_select_outputs"/>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
42 <expand macro="test_log_output">
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
43 <has_text text="dRep compare finished" />
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
44 </expand>
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
45 </test>
0
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
46 </tests>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
47 <help><![CDATA[
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
48 **dRep compare**
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
49
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
50 `dRep <https://drep.readthedocs.io/en/latest/overview.html>`_ performs rapid pair-wise comparison of genome sets.
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
51
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
52 `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).
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
53
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
54 dRep performs this in two steps:
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
55
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
56 - first with a rapid primary algorithm (Mash)
2
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
57 - second with a more sensitive algorithm (ANIm).
0
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
58
2
7de8436f7f97 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 5e6e589002d554be180e575080e9ad66cc78ed74"
iuc
parents: 1
diff changeset
59 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
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
60
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
61 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.
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
62
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
63
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
64 **INPUTS**
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
65
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
66 - Genome sets in fasta format.
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
67
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
68
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
69 **OUTPUTS**
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
70
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
71 - `Figures <https://drep.readthedocs.io/en/latest/example_output.html#figures>`_ that show the relationship of the Genome inputs.
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
72 - `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.
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
73
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
74
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
75 ]]></help>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
76 <expand macro="citations" />
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
77 </tool>