annotate srst2v2.xml @ 1:16c9fccf550d draft

planemo upload
author estrain
date Sat, 02 Dec 2017 13:42:43 -0500
parents ffd5306daa4c
children e372e42148de
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
1 <tool id="srst2" name="SRST2 - Short Read Sequence Typer (v2)" version="0.2.0">
0
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
2 <requirements>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
3 <requirement type="package" version="0.2.0">srst2</requirement>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
4 </requirements>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
6 #if $paired_conditional.sPaired == "paired"
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
7 ln -s $paired_conditional.fastq1 sample_1.fastq;
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
8 ln -s $paired_conditional.fastq2 sample_2.fastq;
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
9 #end if
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
10
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
11 srst2
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
12
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
13 #if $paired_conditional.sPaired == "single"
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
14 --input_se $paired_conditional.fastq1
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
15 #else if $paired_conditional.sPaired == "paired"
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
16 --input_pe sample_1.fastq sample_2.fastq
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
17 #end if
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
18
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
19 --output srst2out
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
20 --save_scores
1
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
21
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
22 #if $job_type.job == "mlst"
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
23 --mlst_definitions $job_type.mlst_definitions
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
24 --mlst_db $job_type.mlst_db
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
25 --mlst_delimiter $job_type.mlstdelim
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
26 --mlst_max_mismatch $job_type.mlst_max_mismatch
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
27 #else if $job_type.job == "gene"
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
28 --gene_db $job_type.genedb
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
29 --gene_max_mismatch $job_type.gene_max_mismatch
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
30 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
31
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
32 #if $options.select == "advanced"
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
33 #if $options.min_coverage
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
34 --min_coverage $options.min_coverage
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
35 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
36 #if $options.max_divergence
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
37 --max_divergence $options.max_divergence
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
38 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
39 #if $options.min_depth
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
40 --min_depth $options.min_depth
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
41 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
42 #if $options.min_edge_depth
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
43 --min_edge_depth $options.min_edge_depth
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
44 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
45 #if $options.prob_err
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
46 --prob_err $options.prob_err
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
47 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
48 #if $options.stop_after
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
49 --stop_after $options.stop_after
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
50 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
51 --other "'-p \${GALAXY_SLOTS:-1}
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
52 #if $options.maxins
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
53 --maxins $options.maxins
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
54 --minins $options.minins
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
55 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
56 '"
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
57 #if $options.mapq
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
58 --mapq $options.mapq
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
59 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
60 #if $options.baseq
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
61 --baseq $options.baseq
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
62 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
63 #else
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
64 --other "'-p \${GALAXY_SLOTS:-1}'"
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
65 #end if
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
66 ;
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
67 #if $job_type.job == "mlst"
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
68 python $__tool_directory__/scoreProfiles.py $job_type.mlst_definitions $job_type.profile_cov $job_type.profile_max_mismatch > srst2.pscores
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
69 #end if
0
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
70
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
71 ]]></command>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
72 <inputs>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
73 <conditional name="paired_conditional">
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
74 <param name="sPaired" type="select" label="Single-End or Paired-End FASTQ?">
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
75 <option value="single">Single-end</option>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
76 <option value="paired">Paired-end</option>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
77 </param>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
78 <when value="single">
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
79 <param name="fastq1" type="data" format="fastq" label="FASTQ file" help="FASTQ" />
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
80 </when>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
81 <when value="paired">
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
82 <param name="fastq1" type="data" format="fastq" label="Forward FASTQ file" help="FASTQ" />
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
83 <param name="fastq2" type="data" format="fastq" label="Reverse FASTQ file" help="FASTQ" />
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
84 </when>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
85 </conditional>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
86
1
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
87 <conditional name="job_type">
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
88 <param name="job" type="select" label="MLST or Gene Presence/Absence?">
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
89 <option value="mlst">MLST</option>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
90 <option value="gene">Gene</option>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
91 </param>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
92 <when value="mlst">
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
93 <param type="data" name="mlst_db" label="Fasta file of MLST alleles" format="fasta" />
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
94 <param type="data" name="mlst_definitions" label="ST definitions for MLST scheme" format="tabular" />
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
95 <param type="text" name="mlstdelim" value="_" format="txt" label="Character(s) separating gene name from allele number in MLST database (default &apos;_&apos;)" />
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
96 <param type="integer" name="mlst_max_mismatch" value="10" format="txt" label="Maximum number of mismatches per read (default 10)" />
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
97 <param type="float" name="profile_max_mismatch" value="3" format="txt" label="Mean mismatches for reporting profile" />
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
98 <param type="float" name="profile_cov" value="90" format="txt" label="Mean % Coverage for reporting profile)" />
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
99
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
100 </when>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
101 <when value="gene">
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
102 <param name="genedb" type="data" format="fasta" label="Fasta file for gene database" />
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
103 <param name="gene_max_mismatch" type="integer" value="10" format="txt" label="Maximum number of mistaches per read (default 10)" />
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
104 </when>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
105 </conditional>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
106
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
107 <conditional name="options">
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
108 <param name="select" type="select" label="Options Type">
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
109 <option value="basic">Basic</option>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
110 <option value="advanced">Advanced</option>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
111 </param>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
112 <when value="advanced">
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
113 <param name="min_coverage" type="integer" label="Minimum %coverage cutoff for gene reporting" value="90"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
114 <param name="max_divergence" type="integer" label="Maximum %divergence cutoff for gene reporting" value="10"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
115 <param name="min_depth" type="integer" label="Minimum mean depth to flag as dubious allele call" value="5"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
116 <param name="min_edge_depth" type="integer" label="Minimum edge depth to flag as dubious allele call" value="2"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
117 <param name="prob_err" type="float" label="Probability of sequencing error" value="0.01"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
118 <param name="stop_after" type="integer" label="Stop mapping after this number of reads have been mapped (otherwise map all)" optional="true"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
119 <param name="mapq" type="integer" label="Samtools -q parameter" value="1"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
120 <param name="baseq" type="integer" label="Samtools -Q parameter" value="20"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
121 <param name="minins" type="integer" label="Bowtie 2 -I parameter. The minimum fragment length for valid paired-end alignments." value="0" >
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
122 <validator type="in_range" message="Must be less than -X parameter." min="0"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
123 </param>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
124 <param name="maxins" type="integer" label="Bowtie 2 -X parameter. The maximum fragment length for valid paired-end alignments." value="1000" >
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
125 <validator type="in_range" message="Must be greater than -I parameter." min="0"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
126 </param>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
127 </when>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
128 <when value="basic"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
129 </conditional>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
130
0
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
131 </inputs>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
132
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
133 <outputs>
1
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
134 <data format="txt" label="Allele Scores" name="scores" from_work_dir="*.scores"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
135 <data format="txt" label="Profile Scores" name="pscores" from_work_dir="*.pscores"/>
16c9fccf550d planemo upload
estrain
parents: 0
diff changeset
136 <data format="txt" label="Predicted Alleles" name="alleles" from_work_dir="*results.txt"/>
0
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
137 </outputs>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
138
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
139 <help><![CDATA[
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
140
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
141 SRST2 - Short Read Sequence Typer (v2)
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
142
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
143 This program is designed to take Illumina sequence data, a MLST database and/or a database of gene sequences (e.g. resistance genes, virulence genes, etc) and report the presence of STs and/or reference genes.
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
144
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
145 ]]></help>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
146
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
147
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
148 <citations>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
149 <citation type="bibtex">
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
150 @misc{pope_dashnow_zobel_holt_raven_schultz_inouye_tomita_2014,
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
151 title={SRST2: Rapid genomic surveillance for public health and hospital microbiology labs},
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
152 url={https://genomemedicine.biomedcentral.com/articles/10.1186/s13073-014-0090-6},
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
153 journal={Genome Medicine}, publisher={BioMed Central},
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
154 author={Pope, Bernard J and Dashnow, Harriet and Zobel, Justin and Holt, Kathryn E and Raven, Lesley-Ann and Schultz, Mark B and Inouye, Michael and Tomita, Takehiro},
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
155 year={2014}, month={Nov}} ,
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
156 }</citation>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
157 </citations>
ffd5306daa4c planemo upload
estrain
parents:
diff changeset
158 </tool>