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