help/html/webServices/dbreffetcher.html

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