annotate drep_compare.xml @ 1:a5054beafded draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
author iuc
date Tue, 31 Aug 2021 08:03:29 +0000
parents 1db0ba55d411
children 7de8436f7f97
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
1 <tool id="drep_compare" name="dRep compare" version="@VERSION@.0" python_template_version="3.5">
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>
1
a5054beafded "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 0
diff changeset
3 <expand macro="bio_tools" />
0
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
4 <macros>
1db0ba55d411 "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>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
6 </macros>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
7 <expand macro="requirements" />
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[
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
9 @PREPARE_GENOMES@
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
10 dRep compare outdir
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
11 @GENOME_COMPARISON_OPTIONS@
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
12 @CLUSTERING_OPTIONS@
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
13 @TAXONOMY_OPTIONS@
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
14 @WARNING_OPTIONS@
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
15 @GENOMES@
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
16 ]]></command>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
17 <inputs>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
18 <expand macro="genomes"/>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
19 <expand macro="genome_comparison_options"/>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
20 <expand macro="clustering_options"/>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
21 <expand macro="taxonomy_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="warning_options"/>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
23 <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
24 </inputs>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
25 <outputs>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
26 <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
27 </outputs>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
28 <tests>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
29 <expand macro="test_defaults_log">
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
30 <has_text text="dRep compare finished" />
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
31 </expand>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
32 </tests>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
33 <help><![CDATA[
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
34 **dRep compare**
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
35
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
36 `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
37
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
38 `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
39
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
40 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
41
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
42 - first with a rapid primary algorithm (Mash)
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
43 - second with a more sensitive algorithm (ANIm).
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
44
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
45 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.
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
46
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
47 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
48
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 **INPUTS**
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 - 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
53
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
54
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
55 **OUTPUTS**
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
56
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
57 - `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
58 - `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
59
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 ]]></help>
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
62 <expand macro="citations" />
1db0ba55d411 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
63 </tool>