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 Dialog Box</strong>
  29   </p>
  30
  31   <p>
  32     The Structure Chooser allows you to select
  33     3D structures to view for the currently selected set of
  34     sequences. It is 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   <p>
  50     <strong>Selecting and Viewing Structures</strong>
  51   </p>
  52   <p>The drop-down menu offers different options for structure
  53     discovery; the 'Cached' view is shown automatically if existing
  54     structure data has been imported for the selected sequences, and if
  55     none is available, the import PDB/mmCIF file options are shown.</p>
  56   <p>
  57     Once one or more structures have been selected, pressing the <strong>View</strong>
  58     or <strong>Add</strong> button will import them <a
  59       href="viewingpdbs.html#afterviewbutton">a new or existing
  60       structure view</a>. When multiple views are available, use the
  61     drop-down menu to pick the target viewer for the structures.
  62   </p>
  63   <p>
  64     <strong>Automated discovery of structure data</strong>
  65   </p>
  66   <p>
  67     After selecting "3D Structure Data ..", Jalview queries the PDB via
  68     the PDBe SOLR Rest API provided by EMBL-EBI to discover PDB IDs
  69     associated with the sequence. It does this based on the sequence's
  70     ID string, and any other associated database IDs. <br />
  71     <br />
  72   <p>
  73     <strong><a name="cachedstructview">Viewing existing
  74         structures for your sequences</a></strong>
  75   </p>
  76   <p>
  77     If you have already loaded 3D structure data for the selected
  78     sequences, the structure chooser will first open with the <strong>Cached
  79       Structures View</strong>. This view shows associations between each
  80     sequence, and chains for 3D structure files already in memory. If
  81     you want to download additional structures, select one of the other
  82     options from the drop down menu.
  83   </p>
  84   <p>
  85     <strong>Selection of the best structure for each sequence</strong>
  86   </p>
  87   <p>Jalview can automatically select the best structures according
  88     to meta-data provided by the PDB. For alignments with no existing
  89     structure data, the 'Best Quality' structure for each sequence will
  90     by default be selected, but clicking on the drop down menu allows
  91     other criteria to be chosen, including Resolution (only defined for
  92     X-Ray structures), Highest Protein Chain etc. When 'Invert' is
  93     selected, structures are selected in reverse order for the current
  94     criteria (e.g. worst quality rather than best).</p>
  95   <p>
  96
  97     <img src="schooser_main.png" style="width: 499px; height: 437px;">
  98     <!-- <p><img src="schooser_config.png" style="width: 463px; height: 369px; ">
  99         <p><img src="schooser_drop-down.png" style="width: 464px; height: 368px; ">
 100         <p><img src="schooser_enter-id.png" style="width: 467px; height: 373px; ">
 101         <p><img src="schooser_from-file.png" style="width: 468px; height: 370px; ">
 102         <p><img src="schooser_cached.png"> -->
 103     <br>The screenshot above shows the Structure Chooser displayed after
 104     selecting all the sequences in the Jalview example project. If no
 105     structures were auto-discovered, options for manually associating
 106     PDB records will be shown (see below).<p>
 107     <strong>Exploration of meta-data for available structures</strong>
 108   </p>
 109   <p>Information on each structure available is displayed in columns
 110     in the dialog box. By default, only the title, resolution and PDB
 111     identifier are shown, but many more are provided by the PDBe. To
 112     configure which ones are displayed, select the 'Configure Displayed
 113     Columns' tab and tick the columns which you want to see.</p>
 114   <p>
 115     <img src="schooser_enter-id.png"
 116       style="width: 464px; height: 173px;">
 117       <br/>
 118     <strong>Manual selection/association of PDB files with
 119       Sequences</strong>
 120   </p>
 121   <p>To manually associate PDB files with a sequence, select 'From
 122     File', or 'Enter PDB Id' from the drop-down menu:
 123   <ul>
 124     <li><strong>From File</strong> - allows you to load a PDB file
 125       from the local machine or network and associate it with the
 126       selected sequence. PDB files associated in this way will also be
 127       saved in the <a href="jalarchive.html">Jalview Archive file</a>.<br></li>
 128     <li><strong>Enter PDB Id</strong> - allows you specify a PDB ID
 129       for your sequence. The PDB Rest API, provided by EMBL-EBI, is used
 130       to validate and fetch structure data.<br></li>
 131   </ul>
 132
 133   <p>
 134     <em>The Structure Chooser interface was introduced in Jalview
 135       2.9. </em>
 136   </p>
 137 </body>
 138 </html>