annotate kaptive.xml @ 0:5d73ef083b24 draft default tip

planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
author nml
date Fri, 07 Apr 2017 15:05:57 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
1 <tool id="kaptive" name="Kaptive" version="0.3.0">
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
2 <description>reports information about capsular (K) loci found in genome assemblies.</description>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
3 <requirements>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
4 <requirement type="package" version="0.3">kaptive</requirement>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
5 </requirements>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
6 <stdio>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
7 <exit_code range="1:" level="fatal" description="Unknown error has occurred"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
8 </stdio>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
9 <command><![CDATA[
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
10
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
11 ln -s "$assembly" "$assembly.name" &&
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
12
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
13 kaptive.py --assembly "$assembly.name"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
14
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
15
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
16 --k_refs "$references"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
17 -o 'result'
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
18
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
19 -t "\${GALAXY_SLOTS:-4}"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
20
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
21 #if $allelic_typing:
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
22 --allelic_typing "$allelic_typing"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
23 #end if
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
24
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
25
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
26 #if $start_end_margin:
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
27 --start_end_margin "$start_end_margin"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
28 #end if
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
29
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
30 #if $min_gene_cov:
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
31 --min_gene_cov "$min_gene_cov"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
32 #end if
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
33
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
34 #if $min_gene_id:
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
35 --min_gene_id "$min_gene_id"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
36 #end if
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
37
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
38 #if $low_gene_id:
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
39 --low_gene_id "$low_gene_id"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
40 #end if
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
41
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
42 #if $gap_fill_size:
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
43 --gap_fill_size "$gap_fill_size"
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
44 #end if
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
45
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
46 ]]></command>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
47 <inputs>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
48
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
49 <param name="assembly" type="data" format="fasta" label="Assembly fasta file"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
50
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
51 <param name="references" type="data" format="genbank" label="Genbank referece K loci"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
52
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
53 <param name="allelic_typing" type="data" format="fasta" label="Allelic Typing genes" help="SRST2-formatted file of allelic typing genes to include in results" optional="True"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
54
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
55 <param name="start_end_margin" type="integer" label="Start end margin" help="Missing bases at the ends of K locus allowed in a perfect match. (default: 10)" value="10"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
56
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
57 <param name="min_gene_cov" type="float" label="Minimum % coverage for genes" help="minimum required % coverage for genes (default: 90.0)" value="90.0"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
58
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
59 <param name="min_gene_id" type="float" label="Minimum % identity for genes" help="minimum required % identity for genes (default: 80.0)" value="80.0"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
60
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
61 <param name="low_gene_id" type="float" label="Flag gene with % identity below" help="genes with a % identity below this value will be flagged as low identity (default: 95.0) " value="95.0"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
62
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
63 <param name="gap_fill_size" type="integer" label="Distance to merge assemblies" help="when separate parts of the assembly are found within this distance, they will be merged (default: 100) " value="100"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
64
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
65
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
66
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
67 </inputs>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
68
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
69 <outputs>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
70 <data format="tabular" name="results" label="Report Results" from_work_dir="result_table.txt"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
71 <data format="txt" name="json" label="JSON Results" from_work_dir="result.json"/>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
72 <data format="fasta" name="fasta" label="Fasta Hit Results" from_work_dir="result_*.fasta" />
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
73 </outputs>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
74 <tests>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
75 <test>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
76 <param name="assembly" value="input.fasta" />
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
77 <param name="references" value="Klebsiella_k_locus_primary_reference_db.gbk" />
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
78 <output name="results" file="result_table.txt" />
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
79 <output name="json" file="result.json" />
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
80 <output name="fasta" file="result_input.fasta" />
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
81 </test>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
82 </tests>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
83 <help>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
84 <![CDATA[
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
85
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
86 Documentation available @ https://github.com/katholt/Kaptive/blob/master/README.md
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
87
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
88
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
89 **Acknowledgments**
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
90 Tool Wrapper Author: Philip Mabon
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
91 ]]>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
92 </help>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
93 <citations>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
94 <citation type="doi">10.5281/zenodo.55773</citation>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
95 </citations>
5d73ef083b24 planemo upload commit cf7305a207096e24bedddb0cb55bed86a6b7cd6b
nml
parents:
diff changeset
96 </tool>