automatic dbref fetching and sequence validation for arbitrary databases
authorjprocter <Jim Procter>
Fri, 21 Dec 2007 15:08:26 +0000 (15:08 +0000)
committerjprocter <Jim Procter>
Fri, 21 Dec 2007 15:08:26 +0000 (15:08 +0000)
help/html/features/dasfeatures.html
help/html/webServices/dbreffetcher.html [new file with mode: 0644]

index c2b4d49..3f2674e 100644 (file)
@@ -30,32 +30,13 @@ accession ids, you will be asked whether Jalview should find Uniprot
 Accession ids for the given sequence names. It is important to realise
 that many DAS sources only use Uniprot accession ids, rather than
 Swissprot/Uniprot sequence names.<br>
-<p><strong>The Sequence Identification Process</strong></p>
-The method of Uniprot accession id discovery is the same method which
-earlier Jalview versions used for sequence feature retrieval, and is now
-also used for
-<a href="viewingpdbs.html">PDB ID discovery</a>
-. Essentially, Jalview will try to retrieve Uniprot records via the
-EBI's WSDbFetch interface using each sequence's ID string (or each
-string in the ID separated by the '&#8739;' symbol).
-</p>
-<p>If a uniprot record (or set of records) is found for a sequence,
-then the sequence is aligned to the one in the Uniprot record to
-determine the correct start and end residue positions (which are
-displayed when the 'Show Full Sequence ID' option is set).</p>
-<p>If the alignment reveals differences between the sequence in the
-alignment and the one in the record, then Jalview will assume that the
-aligned sequence is not the one in the uniprot record.</p>
-<p>In some cases, the ID used to retrieve Uniprot records may be out
-of date and a dialog box will be opened indicating that a 100% match
-between the sequence and a Uniprot record was identified, but the
-sequence name is different. In this case, the ID must be manually
-changed (by right clicking on the sequence ID and selecting <strong>Sequence&#8594;Edit
-Name</strong>), before Jalview will show its sequence features.
+The <a href="../webservices/dbreffetcher.html">database reference
+fetcher</a> documentation describes how Jalview discovers what database
+references are appropriate for the sequences in the alignment.
 <ul>
        <li><em>Note</em><br>
        Please remember to save your alignment if either the start/end
-       numbering, or the sequence IDs were updated during the Uniprot ID
+       numbering, or the sequence IDs were updated during the ID 
        retrieval process.</li>
 </ul>
 <p>&nbsp;
diff --git a/help/html/webServices/dbreffetcher.html b/help/html/webServices/dbreffetcher.html
new file mode 100644 (file)
index 0000000..98300aa
--- /dev/null
@@ -0,0 +1,52 @@
+<!DOCTYPE html SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml">\r
+<head>\r
+Database Reference Fetching\r
+</head>\r
+<p>\r
+<p><strong>Discovering Database References for Sequences</strong><br>\r
+Database references are associated with a sequence are displayed as a\r
+list in the tooltip shown when mousing over its sequence ID. Jalview\r
+uses references for the retrieval of <a\r
+       href="../features/viewingpdbs.html">PDB structures</a> and <a\r
+       href="../features/dasfeatures.html">DAS features</a>, and for\r
+retrieving sequence cross-references such as the protein products of a\r
+DNA sequence.</p>\r
+<p>Jalview discovers references for a sequence by generating a set\r
+of ID queries from the ID string of each sequence in the alignment. It\r
+then tries to query all the databases it can access in order to match\r
+the alignment sequence to any records retrieved from the database. If a\r
+match is found, then the sequence is annotated with that database's\r
+reference, and any cross-references that it's records contain.</p>\r
+<p><strong>The Sequence Identification Process</strong><br>\r
+The method of accession id discovery is derived from the method which\r
+earlier Jalview versions used for Uniprot sequence feature retrieval,\r
+and was originally restricted to the identifaction of valid Uniprot\r
+accessions.<br>\r
+Essentially, Jalview will try to retrieve records from all the databases\r
+accessible by the <a href="../features/seqfetch.html">sequence\r
+fetcher</a> using each sequence's ID string (or each string in the ID\r
+separated by the '&#8739;' symbol).</p>\r
+<p>If a record (or set of records) is retrieved by any query derived\r
+from the ID string of a sequence, then the sequence is aligned to the\r
+ones retrieved to determine the correct start and end residue positions\r
+(which are displayed when the 'Show Full Sequence ID' option). This is\r
+important for the correct display of the location of any features\r
+associated with that database.</p>\r
+<p>If the alignment reveals differences between the sequence in the\r
+alignment and the one in the record, then Jalview will assume that the\r
+aligned sequence is not the one in the retrieved record.</p>\r
+<p>In some cases, the ID used to retrieve records may be out\r
+of date and a dialog box will be opened indicating that a 100% match\r
+between the sequence and the record was identified, but the\r
+sequence name is different. In this case, the can be manually\r
+changed (by right clicking on the sequence ID and selecting <strong>Sequence&#8594;Edit\r
+Name</strong>).\r
+<ul>\r
+       <li><em>Note</em><br>\r
+       Please remember to save your alignment if either the start/end\r
+       numbering, or the sequence IDs were updated during the ID\r
+       retrieval process.</li>\r
+</ul>\r
+<body></body>\r
+</html>
\ No newline at end of file