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>The PDB Sequence Fetcher</title>
  24 </head>
  25 <body>
  26
  27   <strong>The PDB Sequence Fetcher</strong>
  28   <p>
  29     Jalview provides a specialised interface that allows fast and
  30     efficient discovery and retrieval of data from the PDB database,
  31     based on the EMBL-EBI's PDBe BioSOLR query interface. It allows
  32     interactive querying of PDB metadata with free text and structured
  33     queries, so structures can be located without prior knowledge of
  34     their database accessions, or <em>via</em> manual cross-referencing
  35     with other bioinformatics websites.
  36   </p>
  37   <p>
  38     To open the PDB Sequence Fetcher, select PDB as the database from
  39     any <a href="seqfetch.html">Sequence Fetcher</a> dialog (opened <em>via</em>
  40     <strong>&quot;File &#8594;Fetch Sequences&quot;</strong>).
  41   </p>
  42   <img src="pdbseqfetcher.png" align="left"
  43     alt="PDB sequence fetcher (introduced in Jalview 2.9)" />
  44
  45   <p>
  46     <strong>Searching the PDB Database</strong>
  47   </p>
  48   <p>
  49     To search the PDB, begin typing in the text box. The results of your
  50     query are shown in the search results tab, which updates every time
  51     you type in the search text box. You can sort results according to
  52     the displayed columns, and select entries with the mouse and
  53     keyboard. Once you have selected one or more entries, hit the <strong>OK</strong>
  54     button to retrieve and view them in Jalview.
  55   </p>
  56   <p>
  57   <ul>
  58     <li><strong>Searching a specific PDB field</strong><br />If
  59       you want to find structures based on a specific PDB metadata
  60       field, you can select it from the drop-down menu.</li>
  61     <li><strong>Retrieving a unique chain for a PDB entry</strong><br>To
  62       retrieve a specific chain for a PDB entry, append the PDB ID with
  63       a colon followed by the chain code in the search box.<br /> e.g
  64       1xyz:A</li>
  65
  66     <li><strong>Bulk PDB retrieval</strong><br>Multiple PDB
  67       IDs can be specified by separating them with a semi-colon.<br />
  68       e.g. 1xyz;2xyz;3xyz<br />Hitting Return or OK will automatically
  69       fetch those IDs, like the default Sequence Fetcher interface.</li>
  70
  71     <li><strong>Wild card searching</strong><br>The following
  72       wild cards are supported by the EMBL-EBI PDBe query service:
  73       <ul>
  74         <li><strong>?</strong> matches a single character<br />The
  75           search string te?t would match both test and text.</li>
  76         <li><strong>*</strong> matches multiple characters<br />The
  77           search string: tes* - would match test, testing, and tester.</li>
  78       </ul> <em>Note:</em> you can use wildcard characters anywhere in a
  79       query string.<br />For example: te*t - would match test and text.
  80       *est - would match pest and test.</li>
  81     <li><strong>Structured queries</strong><br />The PDBe SOLR
  82       interface supports boolean query syntax, allowing quoted search
  83       strings to be combined with AND, OR, and NOT. Currently, no
  84       special support for constructing these queries is provided in the
  85       query dialog box.</li>
  86   </ul>
  87   <p>
  88     <strong>Customising The PDB Sequence Fetcher</strong>
  89   </p>
  90   <p>
  91     To change the displayed meta-data in the search result, click the
  92     'Configure Displayed Columns' tab, and select the fields you'd like
  93     displayed. These fields can also be configured <em>via</em> the
  94     Structure tab of the <a href="preferences.html#structure">Jalview
  95       Desktop Preferences</a>.
  96   </p>
  97   <p>
  98     <em>The PDB Sequence Fetcher interface was introduced in
  99       Jalview 2.9</em>
 100   </p>
 101 </body>
 102 </html>