help/html/webServices/dbreffetcher.html

   1 <!--
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18 -->
  19 <!DOCTYPE html SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  20 <html xmlns="http://www.w3.org/1999/xhtml">
  21 <head>
  22 Database Reference Fetching
  23 </head>
  24 <p>
  25 <p><strong>Discovering Database References for Sequences</strong><br>
  26 Database references are associated with a sequence are displayed as a
  27 list in the tooltip shown when mousing over its sequence ID. Jalview
  28 uses references for the retrieval of <a
  29         href="../features/viewingpdbs.html">PDB structures</a> and <a
  30         href="../features/dasfeatures.html">DAS features</a>, and for
  31 retrieving sequence cross-references such as the protein products of a
  32 DNA sequence.</p>
  33 <p><strong>Initiating reference retrieval</strong><br>
  34 The application provides three ways to access the retrieval function. Either:
  35 <ul><li>select the <strong>Discover PDB IDs</strong> option from the structure submenu of the sequence's popup menu</li>
  36 <li>Choose one of the options from the 'Fetch DB Refs' submenu in the alignment window's <strong>Web Services</strong> menu:<ul>
  37 <li><em>Standard Databases</em> will fetch references from the EBI databases plus currently selected DAS sources</li>
  38 <li>The other entries submenus leading to lists of individual database sources that Jalview can access.</li></ul></li>
  39 <li>Answer 'Yes' when asked if you wish to retrieve database references for your sequences after initiating a DAS Sequence Feature fetch.</li>
  40 </ul>
  41 <p>Jalview discovers references for a sequence by generating a set
  42 of ID queries from the ID string of each sequence in the alignment. It
  43 then tries to query a subset of all the databases it can access in order to match
  44 the alignment sequence to any records retrieved from the database. If a
  45 match is found, then the sequence is annotated with that database's
  46 reference, and any cross-references that it's records contain.</p>
  47 <p><strong>The Sequence Identification Process</strong><br>
  48 The method of accession id discovery is derived from the method which
  49 earlier Jalview versions used for Uniprot sequence feature retrieval,
  50 and was originally restricted to the identifaction of valid Uniprot
  51 accessions.<br>
  52 Essentially, Jalview will try to retrieve records from a subset of the databases
  53 accessible by the <a href="../features/seqfetch.html">sequence
  54 fetcher</a> using each sequence's ID string (or each string in the ID
  55 separated by the '&#8739;' symbol).</p>
  56 <p>If a record (or set of records) is retrieved by any query derived
  57 from the ID string of a sequence, then the sequence is aligned to the
  58 ones retrieved to determine the correct start and end residue positions
  59 (which are displayed when the 'Show Full Sequence ID' option). This is
  60 important for the correct display of the location of any features
  61 associated with that database.</p>
  62 <p>If the alignment reveals differences between the sequence in the
  63 alignment and the one in the record, then Jalview will assume that the
  64 aligned sequence is not the one in the retrieved record.</p>
  65 <p>In some cases, the ID used to retrieve records may be out
  66 of date and a dialog box will be opened indicating that a 100% match
  67 between the sequence and the record was identified, but the
  68 sequence name is different. In this case, the can be manually
  69 changed (by right clicking on the sequence ID and selecting <strong>Sequence&#8594;Edit
  70 Name</strong>).
  71 <ul>
  72         <li><em>Note</em><br>
  73         Please remember to save your alignment if either the start/end
  74         numbering, or the sequence IDs were updated during the ID
  75         retrieval process.</li>
  76 </ul>
  77 <body></body>
  78 </html>