File: whichdb.html

package info (click to toggle)
emboss 6.6.0%2Bdfsg-1
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 571,248 kB
ctags: 39,971
sloc: ansic: 460,578; java: 29,439; perl: 13,573; sh: 12,740; makefile: 3,275; csh: 706; asm: 351; xml: 239; pascal: 237; modula3: 8
file content (594 lines) | stat: -rw-r--r-- 15,085 bytes
parent folder | download | duplicates (6)
<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="/images/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>
Wiki
</H2>

The master copies of EMBOSS documentation are available
at <a href="http://emboss.open-bio.org/wiki/Appdocs">
http://emboss.open-bio.org/wiki/Appdocs</a>
on the EMBOSS Wiki.

<p>
Please help by correcting and extending the Wiki pages.

<H2>
    Function
</H2>
Search all sequence databases for an entry and retrieve it
<H2>
    Description
</H2>

<p><b>whichdb</b> searches all available sequence databases for sequences with a specified ID name or accession number.  The uniform sequence address (USA) of matching database entries is written to an output file. <b>whichdb</b> will, optionally, write out the sequences it finds to files.  An "available" database is one that has been defined in the EMBOSS system file (<tt>.embossrc</tt> or <tt>emboss.login</tt>) and is available from the system you are running EMBOSS. If you do not know which database(s) contain the entry you are interested in, <b>whichdb</b> will tell you.</p>


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

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

% <b>whichdb -showall </b>
Search all sequence databases for an entry and retrieve it
ID or Accession number: <b>x65923</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>
Search all sequence databases for an entry and retrieve it
Version: EMBOSS:6.6.0.0

   Standard (Mandatory) qualifiers (* if not always prompted):
  [-entry]             string     ID or Accession number (Any string)
*  -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 first file to standard output
   -filter             boolean    Read first file from standard input, write
                                  first file to 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 and exit. 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
   -version            boolean    Report version number and exit

</pre>
</td></tr></table>
<P>
<table border cellspacing=0 cellpadding=3 bgcolor="#ccccff">
<tr bgcolor="#FFFFCC">
<th align="left">Qualifier</th>
<th align="left">Type</th>
<th align="left">Description</th>
<th align="left">Allowed values</th>
<th align="left">Default</th>
</tr>

<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>Standard (Mandatory) qualifiers</th>
</tr>

<tr bgcolor="#FFFFCC">
<td>[-entry]<br>(Parameter 1)</td>
<td>string</td>
<td>ID or Accession number</td>
<td>Any string</td>
<td>&nbsp;</td>
</tr>

<tr bgcolor="#FFFFCC">
<td>-outfile</td>
<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=5>Additional (Optional) qualifiers</th>
</tr>

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

<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>Advanced (Unprompted) qualifiers</th>
</tr>

<tr bgcolor="#FFFFCC">
<td>-get</td>
<td>toggle</td>
<td>Retrieve sequences</td>
<td>Toggle value Yes/No</td>
<td>No</td>
</tr>

<tr bgcolor="#FFFFCC">
<td>-showall</td>
<td>boolean</td>
<td>Show failed attempts</td>
<td>Boolean value Yes/No</td>
<td>No</td>
</tr>

<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>Associated qualifiers</th>
</tr>

<tr bgcolor="#FFFFCC">
<td align="left" colspan=5>"-outfile" associated outfile qualifiers
</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -odirectory</td>
<td>string</td>
<td>Output directory</td>
<td>Any string</td>
<td>&nbsp;</td>
</tr>

<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>General qualifiers</th>
</tr>

<tr bgcolor="#FFFFCC">
<td> -auto</td>
<td>boolean</td>
<td>Turn off prompts</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -stdout</td>
<td>boolean</td>
<td>Write first file to standard output</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -filter</td>
<td>boolean</td>
<td>Read first file from standard input, write first file to standard output</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -options</td>
<td>boolean</td>
<td>Prompt for standard and additional values</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -debug</td>
<td>boolean</td>
<td>Write debug output to program.dbg</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -verbose</td>
<td>boolean</td>
<td>Report some/full command line options</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -help</td>
<td>boolean</td>
<td>Report command line options and exit. More information on associated and general qualifiers can be found with -help -verbose</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -warning</td>
<td>boolean</td>
<td>Report warnings</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -error</td>
<td>boolean</td>
<td>Report errors</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -fatal</td>
<td>boolean</td>
<td>Report fatal errors</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -die</td>
<td>boolean</td>
<td>Report dying program messages</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>

<tr bgcolor="#FFFFCC">
<td> -version</td>
<td>boolean</td>
<td>Report version number and exit</td>
<td>Boolean value Yes/No</td>
<td>N</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 'bpembl:x65923'
bpembl:x65923
# Trying 'bpgb:x65923'
bpgb:x65923
# Trying 'bpsw:x65923'
# Failed 'bpsw:x65923'
# Trying 'bpworm:x65923'
# Failed 'bpworm:x65923'
# Trying 'ena:x65923'
ena:x65923
# Trying 'qanfasta:x65923'
# Failed 'qanfasta:x65923'
# Trying 'qanfastaall:x65923'
# Failed 'qanfastaall:x65923'
# Trying 'qanflat:x65923'
# Failed 'qanflat:x65923'
# Trying 'qanflatall:x65923'
qanflatall:x65923
# Trying 'qanflatexc:x65923'
qanflatexc:x65923
# Trying 'qanflatinc:x65923'
# Failed 'qanflatinc:x65923'
# Trying 'qangcg:x65923'
qangcg:x65923
# Trying 'qangcgall:x65923'
qangcgall:x65923
# Trying 'qangcgexc:x65923'
qangcgexc:x65923
# Trying 'qangcginc:x65923'
# Failed 'qangcginc:x65923'
# Trying 'qanxfasta:x65923'
# Failed 'qanxfasta:x65923'
# Trying 'qanxfastaall:x65923'
# Failed 'qanxfastaall:x65923'
# Trying 'qanxflat:x65923'
# Failed 'qanxflat:x65923'
# Trying 'qanxflatall:x65923'
qanxflatall:x65923
# Trying 'qanxflatexc:x65923'
qanxflatexc:x65923
# Trying 'qanxflatinc:x65923'
# Failed 'qanxflatinc:x65923'
# Trying 'qanxgcg:x65923'
qanxgcg:x65923
# Trying 'qanxgcgall:x65923'
qanxgcgall:x65923
# Trying 'qanxgcgexc:x65923'
qanxgcgexc:x65923
# Trying 'qanxgcginc:x65923'
# Failed 'qanxgcginc:x65923'


<font color=red>  [Part of this file has been deleted for brevity]</font>

# Failed 'qapir:x65923'
# Trying 'qapirall:x65923'
# Failed 'qapirall:x65923'
# Trying 'qapirexc:x65923'
# Failed 'qapirexc:x65923'
# Trying 'qapirinc:x65923'
# Failed 'qapirinc:x65923'
# Trying 'qapxfasta:x65923'
# Failed 'qapxfasta:x65923'
# Trying 'qapxflat:x65923'
# Failed 'qapxflat:x65923'
# Trying 'qasrswww:x65923'
# Failed 'qasrswww:x65923'
# Trying 'qawfasta:x65923'
# Failed 'qawfasta:x65923'
# Trying 'qawxfasta:x65923'
# Failed 'qawxfasta:x65923'
# Trying 'qaxembl:x65923'
qaxembl:x65923
# Trying 'qaxpir:x65923'
# Failed 'qaxpir:x65923'
# Trying 'qaxpirall:x65923'
# Failed 'qaxpirall:x65923'
# Trying 'qaxpirexc:x65923'
# Failed 'qaxpirexc:x65923'
# Trying 'qaxpirinc:x65923'
# Failed 'qaxpirinc:x65923'
# Trying 'tembl:x65923'
tembl:x65923
# Trying 'temblall:x65923'
temblall:x65923
# Trying 'temblrest:x65923'
# Failed 'temblrest:x65923'
# Trying 'temblvrt:x65923'
temblvrt:x65923
# Trying 'tensembldasgrch37:x65923'
# Failed 'tensembldasgrch37:x65923'
# Trying 'testdb:x65923'
# Failed 'testdb:x65923'
# Trying 'tgb:x65923'
tgb:x65923
# Trying 'tgenbank:x65923'
tgenbank:x65923
# Trying 'tgenedashuman:x65923'
# Failed 'tgenedashuman:x65923'
# Trying 'tpir:x65923'
# Failed 'tpir:x65923'
# Trying 'tsw:x65923'
# Failed 'tsw:x65923'
# Trying 'tswnew:x65923'
# Failed 'tswnew:x65923'
</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 'x65923' 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>
<pre>
Writing x65923.embl
Writing x65923.human
Writing x65923.tembl
Writing x65923.em
Writing x65923.genbank
Writing x65923.gb
</td></tr></table><p>



<H2>
    Data files
</H2>

None.

<H2>
    Notes
</H2>

<p>The Uniform Sequence Addresss (USA) method used by EMBOSS for referencing sequences 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 <tt>embl:x65923</tt>, not just <tt>x65923</tt>.  <b>whichdb</b> is useful where you do not know the database that a sequence entry is found in.</p>


<h3>IDs and Accessions</h3>
<p>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>

<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 the early years of EMBL and GenBank the first two (or three) letters indicated the species and the rest indicated the function, for example <tt>HSFAU</tt> was the <tt>Homo Sapiens FAU pseudogene</tt>. 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 <tt>X65923</tt>, the same as the Accession number for that sequence in EMBL. The protein sequence databases continue to use recognizable names for entries (for example <tt>AMIR_PSEAE</tt> for the AmiR gene product of Pseudomonas aeruginosa in UniProt/SwissProt).</p>

<p>ID names are not guaranteed to remain the same between different versions of a database (although in practice they usually do). In contrast, 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. EMBL, GenBank and UniProt/SwissProt share an Accession numbering scheme - an Accession number uniquely identifies a sequence within these three databases. </p>

<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="abiview.html">abiview</a></td>
<td>Display the trace in an ABI sequencer file</td>
</tr>

<tr>
<td><a href="coderet.html">coderet</a></td>
<td>Extract CDS, mRNA and translations from feature tables</td>
</tr>

<tr>
<td><a href="entret.html">entret</a></td>
<td>Retrieve sequence entries from flatfile databases and files</td>
</tr>

<tr>
<td><a href="extractalign.html">extractalign</a></td>
<td>Extract regions from a sequence alignment</td>
</tr>

<tr>
<td><a href="infoalign.html">infoalign</a></td>
<td>Display basic information about a multiple sequence alignment</td>
</tr>

<tr>
<td><a href="infoseq.html">infoseq</a></td>
<td>Display basic information about sequences</td>
</tr>

<tr>
<td><a href="refseqget.html">refseqget</a></td>
<td>Get reference sequence</td>
</tr>

<tr>
<td><a href="seqxref.html">seqxref</a></td>
<td>Retrieve all database cross-references for a sequence entry</td>
</tr>

<tr>
<td><a href="seqxrefget.html">seqxrefget</a></td>
<td>Retrieve all cross-referenced data for a sequence entry</td>
</tr>

<tr>
<td><a href="showalign.html">showalign</a></td>
<td>Display a multiple sequence alignment in pretty format</td>
</tr>

<tr>
<td><a href="variationget.html">variationget</a></td>
<td>Get sequence variations</td>
</tr>

</table>



<H2>
    Author(s)
</H2>
Alan Bleasby 
<br>
European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK

<p>
Please report all bugs to the EMBOSS bug team (emboss-bug&nbsp;&copy;&nbsp;emboss.open-bio.org) not to the original author.

<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>