help/html/features/structurechooser.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>Structure Chooser</title>
  24 </head>
  25
  26 <body>
  27   <p>
  28     <strong>Structure Chooser</strong>
  29   </p>
  30
  31   <p>
  32     The Structure Chooser interface allows you to interactively select
  33     which PDB structures to view for the currently selected set of
  34     sequences. It's opened by selecting the <strong>"3D
  35       Structure Data.."</strong> option from the Sequence ID panel's <a
  36       href="../menus/popupMenu.html">pop-up menu</a>. The dialog
  37     provides:
  38   </p>
  39   <ul>
  40     <li>Automatic discovery, retrieval and association of PDB
  41       entries for sequences</li>
  42     <li>Exploration of meta-data for available 3D structures</li>
  43     <li>Automatic selection of the 'best structure' to display for
  44       each sequence</li>
  45     <li>Manual association of PDB entries by entering a PDB Id</li>
  46     <li>Association of structure data from a local file (in mmCIF
  47       or PDB format)</li>
  48   </ul>
  49
  50   <p>
  51     <strong>Automated discovery of structure data</strong>
  52   </p>
  53   <p>After selecting "3D Structure Data ..", Jalview queries the PDB
  54     via the PDBe SOLR Rest API provided by EMBL-EBI to discover PDB ids
  55     associated with the sequence. It does this based on the sequence's
  56     ID string, and any other associated database IDs.</p>
  57   <p>
  58     <strong>Exploration of meta-data for available structures</strong>
  59   </p>
  60   <p>Information on each structure available is displayed in columns
  61     in the dialog box. By default, only the title, resolution and PDB
  62     identifier are shown, but many more are provided by the PDBe. To
  63     configure which ones are displayed, select the 'Configure Displayed
  64     Columns' tab and tick the columns which you want to see.</p>
  65   <p>
  66     <strong>Selection of the best structure for each sequence</strong>
  67   </p>
  68   <p>Jalview can automatically select the best structures according
  69     to meta-data provided by the PDB. By default, the 'Best Quality'
  70     structure for each sequence will be selected, but clicking on the
  71     drop down menu allows other criteria to be chosen, including
  72     Resolution (only defined for X-Ray structures), Highest Protein
  73     Chain etc. When 'Invert' is selected, structures are selected in
  74     reverse order for the current criteria (e.g. worst quality rather
  75     than best).</p>
  76   <p>
  77
  78     <img src="schooser_main.png" style="width: 464px; height: 369px;">
  79     <!-- <p><img src="schooser_config.png" style="width: 463px; height: 369px; ">
  80         <p><img src="schooser_drop-down.png" style="width: 464px; height: 368px; ">
  81         <p><img src="schooser_enter-id.png" style="width: 467px; height: 373px; ">
  82         <p><img src="schooser_from-file.png" style="width: 468px; height: 370px; ">
  83         <p><img src="schooser_cached.png"> -->
  84     <br>The screenshot above shows the Structure Chooser interface
  85     along with the meta-data of auto-discovered structures for the
  86     sample alignment. Note however that if no structures were
  87     auto-discovered, a different interface for manual association will
  88     be invoked as seen in the screenshot below.
  89   <p>
  90     <img src="schooser_enter-id.png"
  91       style="width: 464px; height: 369px;">
  92   <p>
  93     <strong>Manual selection/association of PDB files with
  94       Sequences</strong>
  95   </p>
  96   <p>To manually associate PDB files with a sequence, select 'From
  97     File', or 'Enter PDB Id' from the drop-down menu:
  98   <ul>
  99     <li><strong>From File</strong> - allows you to load a PDB file
 100       from the local machine or network and associate it with the
 101       selected sequence. PDB files associated in this way will also be
 102       saved in the <a href="jalarchive.html">Jalview Archive file</a>.<br></li>
 103     <li><strong>Enter PDB Id</strong> - allows you specify a PDB ID
 104       for your sequence. The PDB Rest API, provided by EMBL-EBI, is used
 105       to validate and fetch structure data.<br></li>
 106   </ul>
 107   <p>
 108     <strong>Viewing existing structures for your sequences</strong>
 109   </p>
 110   <p>
 111     If you have previously associated structure data on the alignment,
 112     selecting <strong>Cached PDB Entries</strong> from the drop down
 113     menu allows you to select these structures for display.
 114   </p>
 115
 116   <p>
 117     <em>The Structure Chooser interface was introduced in Jalview
 118       2.9. </em>
 119   </p>
 120 </body>
 121 </html>