annotate fastani.xml @ 0:93549392d20d draft default tip

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
author thanhlv
date Fri, 19 Jul 2019 06:49:02 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
1 <tool id="fastani" name="FastANI" version="1.1">
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
2 <description> fast alignment-free computation of whole-genome Average Nucleotide Identity</description>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
3 <macros>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
4 <import>macros.xml</import>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
5 </macros>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
6 <expand macro="requirements" />
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
7 <version_command>fastANI --version</version_command>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
8 <command detect_errors="exit_code">
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
9 <![CDATA[
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
10 #for $counter_q, $input_q in enumerate($query):
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
11 ln -fs '$input_q' ${input_q.element_identifier}_query &&
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
12 echo ${input_q.element_identifier}_query >> query.lst &&
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
13 #end for
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
14
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
15 #for $counter_r, $input_r in enumerate($reference):
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
16 ln -fs '$input_r' ${input_r.element_identifier}_ref &&
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
17 echo ${input_r.element_identifier}_query >> ref.lst &&
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
18 #end for
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
19
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
20 fastANI
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
21 #if len($query) == 1 and len($reference) == 1:
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
22 -q ${input_q.element_identifier}_query -r ${input_r.element_identifier}_ref -o output
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
23 #elif len($query) == 1 and len($reference) > 1:
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
24 -q ${input_q.element_identifier}_query --rl ref.lst -o output
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
25 #elif len($query) > 1 and len($reference) > 1:
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
26 --ql query.lst --rl ref.lst -o output
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
27 #end if
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
28
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
29 2>&1
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
30 ]]></command>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
31 <inputs>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
32 <param name="query" type="data" format="fasta" multiple="true" label="Query sequences" />
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
33 <param name="reference" type="data" format="fasta" multiple="true" label="Reference sequence" />
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
34 </inputs>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
35 <outputs>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
36 <data name="output" format="txt" from_work_dir="output" label="${tool.name} on ${on_string} Output"/>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
37 </outputs>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
38 <tests>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
39 <test>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
40 <param name="query" value="Shigella_flexneri_2a_01.fna" />
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
41 <param name="reference" value="Escherichia_coli_str_K12_MG1655.fna" />
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
42 <output name="output" file="fastani.out" compare="sim_size" />
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
43 </test>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
44 </tests>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
45 <help><![CDATA[
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
46 FastANI is developed for fast alignment-free computation of whole-genome
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
47 Average Nucleotide Identity (ANI). ANI is defined as mean nucleotide
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
48 identity of orthologous gene pairs shared between two microbial genomes.
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
49 FastANI supports pairwise comparison of both complete and draft genome
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
50 assemblies. Its underlying procedure follows a similar workflow as described
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
51 by Goris et al. 2007. However, it avoids expensive sequence alignments and
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
52 uses Mashmap as its MinHash based sequence mapping engine to compute the
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
53 orthologous mappings and alignment identity estimates. Based on our
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
54 experiments with complete and draft genomes, its accuracy is on par with
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
55 BLAST-based ANI solver and it achieves two to three orders of magnitude
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
56 speedup. Therefore, it is useful for pairwise ANI computation of large
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
57 number of genome pairs. More details about its speed, accuracy and potential
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
58 applications are described here: "High Throughput ANI Analysis of 90K
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
59 Prokaryotic Genomes Reveals Clear Species Boundaries".
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
60 ]]></help>
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
61 <expand macro="citations" />
93549392d20d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/fastani commit 6410237f37dfd76382f9780e73a14cf48aba3695-dirty
thanhlv
parents:
diff changeset
62 </tool>