annotate cmsearch.xml @ 1:26ef7e66c39b draft

Uploaded
author bgruening
date Sat, 31 Aug 2013 08:03:52 -0400
parents
children 468be760eba3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
1 <tool id="infernal_cmsearch" name="Search covariance model(s)" version="1.1.0">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
2 <description>against a sequence database (cmsearch)</description>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
3 <requirements>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
4 <requirement type="package" version="1.1rc4">infernal</requirement>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
5 </requirements>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
6 <command>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
7 cmsearch --tblout
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
8 --cpu 12
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
9 -o /dev/null
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
10 --tformat $seqdb.ext #target format: fasta, embl, genbank, ddbj, stockholm, pfam, a2m, afa, clustal, and phylip
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
11 $bottomonly
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
12 $toponly
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
13 $cyk
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
14 $notrunc
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
15 $max
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
16 $nohmm
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
17 $mid
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
18 $bitscore_thresholds
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
19 --tblout $outfile
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
20 $g
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
21 #if $A:
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
22 $A $multiple_alignment_output
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
23 #end if
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
24
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
25
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
26 #if $inclusion_thresholds_opts.inclusion_thresholds_selector == "--incE":
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
27 --incE $inclusion_thresholds_opts.incE
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
28 #else:
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
29 --incT $inclusion_thresholds_opts.incT
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
30 #end if
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
31
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
32 #if $reporting_thresholds_opts.reporting_thresholds_selector == "-E":
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
33 -E $inclusion_thresholds_opts.E
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
34 #else:
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
35 -T $inclusion_thresholds_opts.T
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
36 #end if
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
37
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
38 #if $cm_opts.cm_opts_selector == "db":
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
39 $cm_opts.database.fields.path
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
40 #else:
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
41 $cm_opts.cmfile
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
42 #end if
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
43
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
44 $seqdb
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
45
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
46
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
47 2>&#38;1
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
48 </command>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
49 <inputs>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
50
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
51 <param name="seqdb" type="data" format="fasta,embl,genbank" label="Sequence database"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
52
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
53 <conditional name="cm_opts">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
54 <param name="cm_opts_selector" type="select" label="Subject covariance models">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
55 <option value="db" selected="True">Locally installed covariance models</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
56 <option value="histdb">Covariance model from your history</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
57 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
58 <when value="db">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
59 <param name="database" type="select" label="Covariance models">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
60 <options from_file="infernal.loc">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
61 <column name="value" index="0"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
62 <column name="name" index="1"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
63 <column name="path" index="2"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
64 </options>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
65 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
66 </when>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
67 <when value="histdb">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
68 <param name="cmfile" type="data" format="fasta" label="Covariance models"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
69 </when>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
70 </conditional>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
71
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
72 <param name="g" truevalue="-g" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
73 label="Turn on the glocal alignment algorithm ..." help="... global with respect to the query model and local with respect to the target database."/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
74
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
75 <param name="bottomonly" truevalue="--bottomonly" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
76 label="Only search the bottom (Crick) strand of target sequences" help="in the sequence database"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
77 <param name="toponly" truevalue="--toponly" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
78 label="Only search the top (Watson) strand of target sequences" help="in the sequence database"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
79
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
80 <param name="cyk" truevalue="--cyk" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
81 label="Use the CYK algorithm, not Inside, to determine the final score of all hits" help=""/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
82 <param name="--acyk" truevalue="--cyk" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
83 label="Use the CYK algorithm to align hits" help="By default, the Durbin/Holmes optimal accuracy algorithm is used, which finds the alignment that maximizes the expected accuracy of all aligned residues."/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
84
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
85 <param name="notrunc" truevalue="--notrunc" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
86 label="Turn off truncated hit detection" help=""/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
87
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
88 <!-- accelleration pipeline -->
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
89
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
90 <param name="max" truevalue="--max" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
91 label="Turn off all filters, and run non-banded Inside on every full-length target sequence" help="This
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
92 increases sensitivity somewhat, at an extremely large cost in speed."/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
93
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
94 <param name="nohmm" truevalue="--nohmm" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
95 label="Turn off all HMM filter stages " help=""/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
96
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
97 <param name="mid" truevalue="--mid" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
98 label="Turn off the HMM SSV and Viterbi filter stages" help=""/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
99
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
100
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
101 <!-- Options for model-specific score thresholding -->
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
102
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
103 <param name="bitscore_thresholds" type="select" label="Bit score thresholds" help="Curated CM databases may define specific bit score thresholds for each CM, superseding any thresholding based on statistical significance alone.">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
104 <option value="" selected="true">None</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
105 <option value="--cut_ga">GA (gathering) bit scores</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
106 <option value="--cut_nc">NC (noise cutoff) bit score</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
107 <option value="--cut_tc">TC (trusted cutoff) bit score</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
108 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
109
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
110 <!-- Options for inclusion thresholds -->
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
111
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
112
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
113 <conditional name="inclusion_thresholds_opts">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
114 <param name="inclusion_thresholds_selector" type="select" label="Inclusion thresholds"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
115 help="Inclusion thresholds are stricter than reporting thresholds. Inclusion thresholds control which hits are considered to be reliable enough to be included in an output alignment or in a possible subsequent search round, or marked as significant (”!”) as opposed to questionable (”?”) in hit output.">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
116 <option value="--incE" selected="true">Use E-value</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
117 <option value="--incT">Use bit score</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
118 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
119 <when value="--incE">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
120 <param name="incE" type="float" value="0.01" size="5" label="Use E-value" help="of &lt;= X as the hit inclusion threshold.">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
121 <sanitizer>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
122 <valid initial="string.printable">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
123 <remove value="&apos;"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
124 </valid>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
125 </sanitizer>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
126 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
127 </when>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
128 <when value="--incT">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
129 <param name="incT" type="integer" size="5" label="Use bit score" help="of >= X as the hit inclusion threshold.">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
130 <sanitizer>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
131 <valid initial="string.printable">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
132 <remove value="&apos;"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
133 </valid>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
134 </sanitizer>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
135 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
136 </when>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
137 </conditional>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
138
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
139
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
140 <!-- Options controlling reporting thresholds -->
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
141
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
142 <conditional name="reporting_thresholds_opts">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
143 <param name="reporting_thresholds_selector" type="select" label="reporting thresholds"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
144 help="Reporting thresholds control which hits are reported in output files">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
145 <option value="-E" selected="true">Use E-value</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
146 <option value="-T">Use bit score</option>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
147 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
148 <when value="-E">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
149 <param name="E" type="float" value="10.0" size="5" label="Use E-value" help="of &lt;= X as the hit reporting threshold. The default is 10.0, meaning that on average, about 10 false positives will be reported per query, so you can see the top of the noise and decide for yourself if it’s really noise.">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
150 <sanitizer>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
151 <valid initial="string.printable">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
152 <remove value="&apos;"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
153 </valid>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
154 </sanitizer>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
155 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
156 </when>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
157 <when value="-T">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
158 <param name="T" type="integer" size="5" label="Use bit score" help="of >= X as the hit reporting threshold.">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
159 <sanitizer>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
160 <valid initial="string.printable">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
161 <remove value="&apos;"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
162 </valid>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
163 </sanitizer>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
164 </param>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
165 </when>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
166 </conditional>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
167
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
168 <param name="A" truevalue="-A" falsevalue="" checked="False" type="boolean"
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
169 label="Save a multiple alignment of all significant hits ..." help="... those satisfying inclusion thresholds"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
170
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
171
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
172 </inputs>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
173 <outputs>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
174
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
175 <data format="tabular" name="outfile" label="cmsearch on ${on_string}"/>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
176 <data format="tabular" name="multiple_alignment_output" label="cmsearch on ${on_string} (multi alignment)">
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
177 <filter>A is True</filter>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
178 </data>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
179
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
180 </outputs>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
181 <requirements>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
182 </requirements>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
183 <help>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
184
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
185 **What it does**
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
186
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
187 Options for model-specific score thresholding
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
188 ---------------------------------------------
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
189
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
190
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
191 - GA thresholds are generally considered to be the reliable curated thresholds defining family membership; for example, in Rfam, these thresholds define what gets included in Rfam Full alignments based on searches with Rfam Seed models.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
192 - NC thresholds are generally considered to be the score of the highest-scoring known false positive.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
193 - TC thresholds are generally considered to be the score of the lowest-scoring known true positive that is above all known false positives.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
194
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
195
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
196 -g Turn on the glocal alignment algorithm, global with respect to the query model and local with
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
197 respect to the target database. By default, the local alignment algorithm is used which is
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
198 local with respect to both the target sequence and the model. In local mode, the alignment to
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
199 span two or more subsequences if necessary (e.g. if the structures of the query model and
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
200 target sequence are only partially shared), allowing certain large insertions and deletions
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
201 in the structure to be penalized differently than normal indels. Local mode performs better
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
202 on empirical benchmarks and is significantly more sensitive for remote homology detection.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
203 Empirically, glocal searches return many fewer hits than local searches, so glocal may be
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
204 desired for some applications. With -g, all models must be calibrated, even those with zero
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
205 basepairs.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
206
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
207
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
208
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
209
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
210 </help>
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
211 </tool>