annotate getmlst.xml @ 2:0f31ef2dfdde draft default tip

Uploaded
author jen-cabral
date Wed, 04 Feb 2015 15:10:17 -0500
parents a6503f48b2be
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
1 <tool id="getmlst" name="getmlst" version="0.1.3">
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
2 <description>Download MLST datasets by species from pubmlst.org</description>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
3 <command interpreter="perl">
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
4 getmlst.pl \$BASE/getmlst.py $mlst_db $mlst_defs '$species'
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
5 </command>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
6 <inputs>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
7 <param name="species" type="text" label="The name of the genus or genus and species that you want to download." help="Please note you will receive an error if multiple results are returned."/>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
8 </inputs>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
9 <stdio>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
10 <exit_code range="2" level="fatal" description="Please be more specific."/>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
11 <exit_code range="1" level="fatal" description="No species matched your query."/>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
12 </stdio>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
13 <outputs>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
14 <data format="fasta" name="mlst_db" label="MLST Database"/>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
15 <data format="tabular" name="mlst_defs" label="MLST Definitions"/>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
16 </outputs>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
17 <requirements>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
18 <requirement type="package" version="0.1.4.5">srst2</requirement>
2
0f31ef2dfdde Uploaded
jen-cabral
parents: 0
diff changeset
19 <requirement type="package" version="2.7">python</requirement>
0
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
20 </requirements>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
21
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
22 <tests>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
23 <test>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
24 <param name="species" value="Listeria monocytogenes"/>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
25 <output name="mlst_db" file="mlst_database_test.fasta" ftype="fasta"/>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
26 <output name="mlst_defs" file="mlst_definitions_test.tabular" ftype="tabular"/>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
27 </test>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
28 </tests>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
29 <help>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
30 **What it does**
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
31
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
32 Searches a database for a given organism and returns the MLST Database(fasta) and MLST Definitions(tabular).
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
33
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
34 **Usage**
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
35
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
36 Enter the genus and species of the organism to search and press Execute
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
37
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
38 **Tips**
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
39
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
40 1. To produce a list of all species avaialble for a specific genus, enter the genus name and press "Execute".
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
41
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
42 - *Helicobacter* will not generate MLST Database or MLST Definition files and an error will occur however the following output will be generated:
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
43
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
44 - *The following 3 species match your query, please be more specific:*
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
45 - Helicobacter cinaedi
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
46 - Helicobacter pylori
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
47 - Helicobacter suis
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
48
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
49 -
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
50
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
51 2. To return a list of all species available from a database leave the name blank and press "Execute".
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
52
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
53 - Leaving the text field blank will not generate MLST Database or MLST Definition files and an error will occur however the following output will be generated:
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
54
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
55 - *The following 114 species match your query, please be more specific:*
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
56 - Achromobacter spp.
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
57 - Acinetobacter baumannii#1
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
58 - Acinetobacter baumannii#2
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
59 - Aeromonas spp.
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
60 - Anaplasma phagocytophilum
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
61 - Arcobacter spp.
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
62 - Aspergillus fumigatus
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
63 - Bacillus cereus
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
64 - Bacillus licheniformis
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
65 - Bacillus subtilis
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
66 - Bifidobacterium
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
67 - Bordetella spp.
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
68 - Borrelia spp.
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
69 - Brachyspira hampsonii
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
70 - Brachyspira hyodysenteriae
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
71 - Brachyspira intermedia
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
72 - Brachyspira pilosicoli
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
73 - Brachyspira spp.
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
74 - Burkholderia cepacia complex
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
75 - Burkholderia pseudomallei
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
76 - Campylobacter concisus/curvus
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
77 - Campylobacter fetus
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
78 - Campylobacter helveticus
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
79 - Campylobacter hyointestinalis
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
80 - Campylobacter insulaenigrae
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
81 - Campylobacter jejuni
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
82 - Campylobacter lanienae
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
83 - Campylobacter lari
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
84 - Campylobacter sputorum
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
85 - Campylobacter upsaliensis
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
86 - Candida albicans
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
87 - ...
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
88
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
89 </help>
a6503f48b2be Uploaded
jen-cabral
parents:
diff changeset
90 </tool>