help/html/features/pdbsequencefetcher.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3
  11  * of the License, or (at your option) any later version.
  12  *
  13  * Jalview is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty
  15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  16  * PURPOSE.  See the GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  20  * The Jalview Authors are detailed in the 'AUTHORS' file.
  21  -->
  22 <head>
  23 <title>PDB Sequence Fetcher</title>
  24 </head>
  25 <body>
  26
  27         <strong>PDB Sequence Fetcher</strong>
  28         <p>From Jalview 2.x.x a speciliased interface was introduced for
  29                 fast and efficient discovery/retrieval of sequence data from the PDB
  30                 database. The introduced interface enables live querying of PDB data
  31                 on-the-fly thereby eliminating the need to memorise database accession
  32                 or to cross-reference other bioinformatics websites before retrieving
  33                 a sequence data in jalview. The underlying technology is provided by
  34                 EBI and is based on Apache Solr which is a text based search engine.</p>
  35
  36         <p>
  37                 The PDB Sequence Fetcher interface can be opened by selecting <strong>PDB</strong>
  38                 as the choice database from the <strong>'Select Database
  39                         Retrieval Source'</strong> interface of <a href="seqfetch.html">Sequence
  40                         Fetcher</a>.
  41         </p><br>
  42
  43         <img src="pdbseqfetcher.png" align="left"
  44                 alt="PDB sequence fetcher (introduced in Jalview 2.x.x)">
  45
  46         <br>
  47         <p>
  48                 <strong>Searching the PDB Database</strong><br> Once the
  49                 interface is opened, typing in the search text box will execute a live
  50                 query to the PDB database and display the results on-the-fly as seen
  51                 in the screen-shot above. Use the drop-down menu to select a specific
  52                 field to search by in the PDB database, the default option is <strong>'ALL'</strong>.
  53                 Furthermore, the PDB search interface also provides the following
  54                 functionalities:
  55
  56         <ul>
  57                 <li>Retrieving a unique chain for a PDB entry: <br>To retrieve a
  58                         specific chain for a PDB entry, append the PDB ID with a colon
  59                         followed by the chain code in the search box. eg: 1xyz:A
  60                          </li>
  61
  62                 <li>Querying multiple PDB Id's in one operation:<br>The PDB search
  63                 interface supports querying of multiple PDB Ids in one operation by
  64                 separating the list of PDB Ids with a semi-colon i.e: 1xyz;2xyz;3xyz </li>
  65
  66                 <li>Wild card searching: <br>The PDB sequence fetcher also provides
  67                         support for wild card querying of the PDB database. <br>Single
  68                         character (matches a single character) - ? The search string te?t
  69                         would match both test and text. <br>Multiple characters (matches
  70                         zero or more sequential characters) - * The wildcard search: tes* -
  71                         would match test, testing, and tester. You can also use wildcard
  72                         characters in the middle of a term. For example: te*t - would match
  73                         test and text. *est - would match pest and test.
  74                 </li>
  75         </ul>
  76         <p>
  77                 <strong>Customising displayed meta-data</strong> <br>To change the
  78                 displayed meta-data in the search result, click the <strong>'Configure
  79                         Displayed Columns'</strong> tab, then tick off the options wanted.
  80         </p>
  81         <p><strong>Importing Sequence</strong><br>
  82         After querying the PDB database, to import the found data into Jalview, select the entries you wish to import then click the ok button at the bottom of the interface.</p>
  83         <p>
  84                 <em>The PDB Sequence Fetcher interface was introduced in Jalview
  85                         2.x.x.</em>
  86         </p>
  87 </body>
  88 </html>