annotate drep_compare.xml @ 0:ef1c257adcbd draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
author iuc
date Tue, 05 May 2020 06:20:45 -0400
parents
children 7157accd23d0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ef1c257adcbd "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">
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>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
3 <macros>
ef1c257adcbd "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>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
5 </macros>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
6 <expand macro="requirements" />
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
8 @PREPARE_GENOMES@
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
9 dRep compare outdir
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
10 @GENOME_COMPARISON_OPTIONS@
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
11 @CLUSTERING_OPTIONS@
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
12 @TAXONOMY_OPTIONS@
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
13 @WARNING_OPTIONS@
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
14 @GENOMES@
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
15 ]]></command>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
16 <inputs>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
17 <expand macro="genomes"/>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
18 <expand macro="genome_comparison_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="clustering_options"/>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
20 <expand macro="taxonomy_options"/>
ef1c257adcbd "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"/>
ef1c257adcbd "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"/>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
23 </inputs>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
24 <outputs>
ef1c257adcbd "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" />
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
26 </outputs>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
27 <tests>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
28 <expand macro="test_defaults_log">
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
29 <has_text text="dRep compare finished" />
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
30 </expand>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
31 </tests>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
32 <help><![CDATA[
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
33 **dRep compare**
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
34
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
35 `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
36
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
37 `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
38
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
39 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
40
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
41 - first with a rapid primary algorithm (Mash)
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
42 - second with a more sensitive algorithm (ANIm).
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
43
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
44 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.
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
45
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
46 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
47
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 **INPUTS**
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 - 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
52
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
53
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
54 **OUTPUTS**
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
55
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
56 - `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
57 - `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
58
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 ]]></help>
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
61 <expand macro="citations" />
ef1c257adcbd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/drep commit 8fa5ff35b45c2b046c7f4800410cf39cb89a299a"
iuc
parents:
diff changeset
62 </tool>