File: whichdb.html

package info (click to toggle)
emboss 5.0.0-7
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 81,332 kB
  • ctags: 25,201
  • sloc: ansic: 229,873; java: 29,051; sh: 10,636; perl: 8,714; makefile: 1,227; csh: 520; asm: 351; pascal: 237; xml: 94; modula3: 8
file content (474 lines) | stat: -rw-r--r-- 11,062 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
<HTML>
<HEAD>
  <TITLE>
  EMBOSS: whichdb
  </TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" text="#000000">

<table align=center border=0 cellspacing=0 cellpadding=0>
<tr><td valign=top>
<A HREF="/" ONMOUSEOVER="self.status='Go to the EMBOSS home page';return true"><img border=0 src="emboss_icon.jpg" alt="" width=150 height=48></a>
</td>
<td align=left valign=middle>
<b><font size="+6">
whichdb
</font></b>
</td></tr>
</table>
<br>&nbsp;
<p>


<H2>
    Function
</H2>
Search all databases for an entry
<H2>
    Description
</H2>

<b>whichdb</b> searches all available EMBOSS databases for sequences
with a specified ID name or accession number.

<p>

EMBOSS does not allow database entries to be specified by just the ID
name or accession number.  You must specify both the name of the
database and the entry, for example 'embl:hsfau', not just 'hsfau'. 

<p>

If you do not know which database(s) contain the entry you are
interested in, <b>whichdb</b> will tell you.

<p>

<b>whichdb</b> can also, optionally, write out the sequences it finds to
files. 

<H3>IDs and Accessions</H3>

An entry in a database must have some way of being uniquely identified
in that database.  Most sequence databases have two such identifiers for
each sequence - an ID name and an Accession number. 

<p>

Why are there two such identifiers? The ID name was originally intended
to be a human-readable name that had some indication of the function of
its sequence.  In EMBL and GenBank the first two (or three) letters
indicated the species and the rest indicated the function, for example
'hsfau' is the 'Homo Sapiens FAU pseudogene'.  This naming scheme
started to be a problem when the number of entries added each day was so
vast that people could not make up the ID names fast enough.  Instead,
the Accession numbers were used as the ID name.  Therefore you will now
find ID names like 'AF061303', the same as the Accession number for that
sequence in EMBL. 

<p>

ID names are not guaranteed to remain the same between different
versions of a database (although in practice they usually do). 

<p>

Accession numbers are unique alphanumeric identifiers that are
guaranteed to remain with that sequence through the rest of the life of
the database.  If two sequences are merged into one, then the new
sequence will get a new Accession number and the Accession numbers of
the merged sequences will be retained as 'secondary' Accession numbers. 

<p>

EMBL, GenBank and SwissProt share an Accession numbering scheme - an
Accession number uniquely identifies a sequence within these three
databases. 


<H2>
    Usage
</H2>
<b>Here is a sample session with whichdb</b>
<p>

<p>
<table width="90%"><tr><td bgcolor="#CCFFFF"><pre>

% <b>whichdb -showall </b>
Search all databases for an entry
ID or Accession number: <b>x65921</b>
Output file [outfile.whichdb]: <b></b>

</pre></td></tr></table><p>
<p>
<a href="#output.1">Go to the output files for this example</a><p><p>


<H2>
    Command line arguments
</H2>

<table CELLSPACING=0 CELLPADDING=3 BGCOLOR="#f5f5ff" ><tr><td>
<pre>
   Standard (Mandatory) qualifiers (* if not always prompted):
  [-entry]             string     ID or Accession number (Any string is
                                  accepted)
*  -outfile            outfile    [*.whichdb] Output file name

   Additional (Optional) qualifiers: (none)
   Advanced (Unprompted) qualifiers:
   -get                toggle     [N] Retrieve sequences
   -showall            boolean    [N] Show failed attempts

   Associated qualifiers:

   "-outfile" associated qualifiers
   -odirectory         string     Output directory

   General qualifiers:
   -auto               boolean    Turn off prompts
   -stdout             boolean    Write standard output
   -filter             boolean    Read standard input, write standard output
   -options            boolean    Prompt for standard and additional values
   -debug              boolean    Write debug output to program.dbg
   -verbose            boolean    Report some/full command line options
   -help               boolean    Report command line options. More
                                  information on associated and general
                                  qualifiers can be found with -help -verbose
   -warning            boolean    Report warnings
   -error              boolean    Report errors
   -fatal              boolean    Report fatal errors
   -die                boolean    Report dying program messages

</pre>
</td></tr></table>
<P>
<table border cellspacing=0 cellpadding=3 bgcolor="#ccccff">
<tr bgcolor="#FFFFCC">
<th align="left" colspan=2>Standard (Mandatory) qualifiers</th>
<th align="left">Allowed values</th>
<th align="left">Default</th>
</tr>

<tr>
<td>[-entry]<br>(Parameter 1)</td>
<td>ID or Accession number</td>
<td>Any string is accepted</td>
<td><i>An empty string is accepted</i></td>
</tr>

<tr>
<td>-outfile</td>
<td>Output file name</td>
<td>Output file</td>
<td><i>&lt;*&gt;</i>.whichdb</td>
</tr>

<tr bgcolor="#FFFFCC">
<th align="left" colspan=2>Additional (Optional) qualifiers</th>
<th align="left">Allowed values</th>
<th align="left">Default</th>
</tr>

<tr>
<td colspan=4>(none)</td>
</tr>

<tr bgcolor="#FFFFCC">
<th align="left" colspan=2>Advanced (Unprompted) qualifiers</th>
<th align="left">Allowed values</th>
<th align="left">Default</th>
</tr>

<tr>
<td>-get</td>
<td>Retrieve sequences</td>
<td>Toggle value Yes/No</td>
<td>No</td>
</tr>

<tr>
<td>-showall</td>
<td>Show failed attempts</td>
<td>Boolean value Yes/No</td>
<td>No</td>
</tr>

</table>

<H2>
    Input file format
</H2>

None.

<p>


<H2>
    Output file format
</H2>


<a name="output.1"></a>
<h3>Output files for usage example </h3>
<p><h3>File: outfile.whichdb</h3>
<table width="90%"><tr><td bgcolor="#CCFFCC">
<pre>
# Trying 'qanflatall:x65921'
qanflatall:x65921
# Trying 'qangcgall:x65921'
# Failed 'qangcgall:x65921'
# Trying 'twp:x65921'
# Failed 'twp:x65921'
# Trying 'qapblast:x65921'
# Failed 'qapblast:x65921'
# Trying 'tsw:x65921'
# Failed 'tsw:x65921'
# Trying 'qanflatinc:x65921'
# Failed 'qanflatinc:x65921'
# Trying 'qapblastsplit:x65921'
# Failed 'qapblastsplit:x65921'
# Trying 'qangcginc:x65921'
# Failed 'qangcginc:x65921'
# Trying 'qanflatexc:x65921'
qanflatexc:x65921
# Trying 'qangcgexc:x65921'
# Failed 'qangcgexc:x65921'
# Trying 'qapir:x65921'
# Failed 'qapir:x65921'
# Trying 'tgenbank:x65921'
tgenbank:x65921
# Trying 'qanfasta:x65921'
# Failed 'qanfasta:x65921'
# Trying 'qanxflat:x65921'
# Failed 'qanxflat:x65921'
# Trying 'qanxgcg:x65921'
# Failed 'qanxgcg:x65921'
# Trying 'qapflat:x65921'
# Failed 'qapflat:x65921'
# Trying 'qapblastsplitinc:x65921'
# Failed 'qapblastsplitinc:x65921'
# Trying 'qapblastsplitexc:x65921'
# Failed 'qapblastsplitexc:x65921'
# Trying 'qapflatall:x65921'
# Failed 'qapflatall:x65921'
# Trying 'qanxflatall:x65921'
qanxflatall:x65921
# Trying 'qanxflatinc:x65921'
# Failed 'qanxflatinc:x65921'
# Trying 'qanxflatexc:x65921'
qanxflatexc:x65921
# Trying 'testdb:x65921'
# Failed 'testdb:x65921'
# Trying 'genbanksrs:x65921'
genbanksrs:x65921
# Trying 'tpir:x65921'
# Failed 'tpir:x65921'
# Trying 'qasrswww:x65921'
qasrswww:x65921
# Trying 'qanxfasta:x65921'
# Failed 'qanxfasta:x65921'
# Trying 'qanxgcgall:x65921'
# Failed 'qanxgcgall:x65921'
# Trying 'qangcg:x65921'
# Failed 'qangcg:x65921'
# Trying 'qanfastaall:x65921'
# Failed 'qanfastaall:x65921'
# Trying 'qapirall:x65921'
# Failed 'qapirall:x65921'
# Trying 'qanxgcginc:x65921'
# Failed 'qanxgcginc:x65921'
# Trying 'qanxgcgexc:x65921'
# Failed 'qanxgcgexc:x65921'
# Trying 'qapirinc:x65921'
# Failed 'qapirinc:x65921'
# Trying 'qanflat:x65921'
# Failed 'qanflat:x65921'
# Trying 'qanxfastaall:x65921'
# Failed 'qanxfastaall:x65921'
# Trying 'qapfasta:x65921'
# Failed 'qapfasta:x65921'
# Trying 'qawxfasta:x65921'
# Failed 'qawxfasta:x65921'
# Trying 'qapirexc:x65921'
# Failed 'qapirexc:x65921'
# Trying 'tswnew:x65921'
# Failed 'tswnew:x65921'
# Trying 'qaxpirall:x65921'
# Failed 'qaxpirall:x65921'
# Trying 'qapxflat:x65921'
# Failed 'qapxflat:x65921'
# Trying 'qaxpirinc:x65921'
# Failed 'qaxpirinc:x65921'
# Trying 'qapxfasta:x65921'
# Failed 'qapxfasta:x65921'
# Trying 'tembl:x65921'
tembl:x65921
# Trying 'qaxpirexc:x65921'
# Failed 'qaxpirexc:x65921'
# Trying 'qapblastall:x65921'
# Failed 'qapblastall:x65921'
# Trying 'tgb:x65921'
tgb:x65921
# Trying 'qaxpir:x65921'
# Failed 'qaxpir:x65921'
# Trying 'qawfasta:x65921'
# Failed 'qawfasta:x65921'
</pre>
</td></tr></table><p>

<p>

The reported database entries are written out to the specified output file.

<p>

Each database that is defined in the local implementation of EMBOSS
which contains an entry called 'hsfau' is reported.

<p>

Note that where a database is defined under several names ('embl',
'em'), each definition of that database containing the entry is
reported. 

<p>

When the '-get' option is used to output the sequences, they are written
to separate files.  The sequence format they are written in is always
'Fasta' format.  The normal command-line qualifiers for changing the
output formats etc.  will not work in this program. 

<p>

The names of the files that the sequences are written to is reported as
they are written, for example:

<p>
<table width="90%"><tr><td bgcolor="#CCFFCC">
<pre>
Writing hsfau.embl
Writing hsfau.human
Writing hsfau.tembl
Writing hsfau.em
Writing hsfau.genbank
Writing hsfau.gb
</td></tr></table><p>



<H2>
    Data files
</H2>

None.

<H2>
    Notes
</H2>

None.

<H2>
    References
</H2>

None.

<H2>
    Warnings
</H2>

None.

<H2>
    Diagnostic Error Messages
</H2>

None.


<H2>
    Exit status
</H2>

It always exits with status 0.

<H2>
    Known bugs
</H2>

None.

<h2><a name="See also">See also</a></h2>
<table border cellpadding=4 bgcolor="#FFFFF0">
<tr><th>Program name</th><th>Description</th></tr>
<tr>
<td><a href="infoalign.html">infoalign</a></td>
<td>Information on a multiple sequence alignment</td>
</tr>

<tr>
<td><a href="infoseq.html">infoseq</a></td>
<td>Displays some simple information about sequences</td>
</tr>

<tr>
<td><a href="seealso.html">seealso</a></td>
<td>Finds programs sharing group names</td>
</tr>

<tr>
<td><a href="showdb.html">showdb</a></td>
<td>Displays information on the currently available databases</td>
</tr>

<tr>
<td><a href="textsearch.html">textsearch</a></td>
<td>Search sequence documentation. Slow, use SRS and Entrez!</td>
</tr>

<tr>
<td><a href="tfm.html">tfm</a></td>
<td>Displays a program's help documentation manual</td>
</tr>

<tr>
<td><a href="wossname.html">wossname</a></td>
<td>Finds programs by keywords in their one-line documentation</td>
</tr>

</table>



<H2>
    Author(s)
</H2>
Alan Bleasby (ajb&nbsp;&copy;&nbsp;ebi.ac.uk)
<br>
European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK


<H2>
    History
</H2>

Written (Jan 2002) - Alan Bleasby.


<H2>
    Target users
</H2>
This program is intended to be used by everyone and everything, from naive users to embedded scripts.

<H2>
    Comments
</H2>
None

</BODY>
</HTML>