help/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
  36       <a href="../menus/popupMenu.html">pop-up menu</a>. <br/>
  37       <img src="3dstructuredata_popupmenu.png" alt="pop-up menu"/>
  38       <br/>
  39       The dialog
  40     provides:
  41   </p>
  42   <ul>
  43     <li>Automatic discovery, retrieval and association of PDB
  44       entries for sequences</li>
  45     <li>Exploration of meta-data for available 3D structures</li>
  46     <li>Automatic selection of the 'best structure' to display for
  47       each sequence</li>
  48     <li>Manual association of PDB entries by entering a PDB Id</li>
  49     <li>Association of structure data from a local file (in mmCIF
  50       or PDB format)</li>
  51   </ul>
  52   <p>
  53     <strong>Selecting and Viewing Structures</strong>
  54   </p>
  55   <p>The drop-down menu offers different options for structure
  56     discovery; the 'Cached' view is shown automatically if existing
  57     structure data has been imported for the selected sequences, and if
  58     none is available, the import PDB/mmCIF file options are shown.</p>
  59   <p>
  60     Once one or more structures have been selected, pressing the <strong>View</strong>
  61     or <strong>Add</strong> button will import them <a
  62       href="viewingpdbs.html#afterviewbutton">a new or existing
  63       structure view</a>. When multiple views are available, use the
  64     drop-down menu to pick the target viewer for the structures.
  65   </p>
  66   <p>
  67     <strong>Automated discovery of structure data</strong>
  68   </p>
  69   <p>
  70     After selecting "3D Structure Data ..", Jalview queries the PDB via
  71     the PDBe SOLR Rest API provided by EMBL-EBI to discover PDB IDs
  72     associated with the sequence. It does this based on the sequence's
  73     ID string, and any other associated database IDs. <br />
  74     <br />
  75     Since Jalview 2.11.2, you can also <a href="#3dbeaconssearch">initiate a search
  76     of the 3D-Beacons Network</a>.
  77   </p>
  78   <p>
  79     <strong><a name="cachedstructview">Viewing existing
  80         structures for your sequences</a></strong>
  81   </p>
  82   <p>
  83     If you have already loaded 3D structure data for the selected
  84     sequences, the structure chooser will first open with the <strong>Cached
  85       Structures View</strong>. This view shows associations between each
  86     sequence, and chains for 3D structure files already in memory. If
  87     you want to download additional structures, select one of the other
  88     options from the drop down menu.
  89   </p>
  90   <p>
  91     <strong>Selection of the best structure for each sequence</strong>
  92   </p>
  93   <p>Jalview can automatically select the best structures according
  94     to meta-data provided by the PDB. For alignments with no existing
  95     structure data, the 'PDBe Best Quality' structure for each sequence will
  96     by default be selected, but clicking on the drop down menu allows
  97     other criteria to be chosen, including Resolution (only defined for
  98     X-Ray structures), Highest Protein Chain etc. When 'Invert' is
  99     selected, structures are selected in reverse order for the current
 100     criteria (e.g. worst quality rather than best).</p>
 101   <p>
 102
 103     <img src="schooser_main.png" style="width: 499px; height: 437px;">
 104     <!-- <p><img src="schooser_config.png" style="width: 463px; height: 369px; ">
 105         <p><img src="schooser_drop-down.png" style="width: 464px; height: 368px; ">
 106         <p><img src="schooser_enter-id.png" style="width: 467px; height: 373px; ">
 107         <p><img src="schooser_from-file.png" style="width: 468px; height: 370px; ">
 108         <p><img src="schooser_cached.png"> -->
 109     <br>The screenshot above shows the Structure Chooser displayed after
 110     selecting all the sequences in the Jalview example project. If no
 111     structures were auto-discovered, options for manually associating
 112     PDB records will be shown (see below).
 113
 114   <p>
 115     <strong><a name="3dbeaconssearch">3D-Beacons Network Search</a></strong>
 116   </p>
 117   <p>
 118     To initiate a search of the 3D-Beacons Network&mdash;which searches
 119     across experimentally determined and predicted structure models from
 120     several resources including PDBe, AlphaFold DB, SWISS-MODEL, PED, SASDB, Genome3D and
 121     PDBe-KB&mdash;click on the <strong>3D-Beacons Search</strong> button at the top of the
 122     Structure Chooser window.
 123     <br/>
 124     <img src="3dbeacons_button.png"/>
 125     <br/>
 126     The 3D-Beacons Network search requires UniProt references and Jalview will ask
 127     to attempt to fetch these references for the selected sequences.
 128     UniProt references might not always be found in which case you can revert to the PDB
 129     search.
 130     <br/>
 131     <img src="3dbeacons_structurechooser.png"/>
 132     <br/>
 133     If structures are found through the 3D-Beacons network you can filter which structures
 134     are shown using the drop-down filter at the top of the Structure Chooser window.
 135     <br/>
 136     You can view information about each related model, such as the resource providing
 137     each model, in the columns displayed. You can sort the list of models by clicking on
 138     column headings.
 139     <br/>
 140     Select and view the structures in the usual way using the <a href="viewingpdbs.html#afterviewbutton">open structure options</a> at
 141     the bottom of the Structure Chooser window.
 142   </p>
 143
 144   <p>
 145     <strong>Exploration of meta-data for available structures</strong>
 146   </p>
 147   <p>Information on each structure available is displayed in columns
 148     in the dialog box. By default, only the title, resolution and PDB
 149     identifier are shown, but many more are provided by the PDBe. To
 150     configure which ones are displayed, select the 'Configure Displayed
 151     Columns' tab and tick the columns which you want to see.</p>
 152   <p>
 153     <img src="schooser_enter-id.png"
 154       style="width: 464px; height: 173px;">
 155       <br/>
 156     <strong>Manual selection/association of PDB files with
 157       Sequences</strong>
 158   </p>
 159   <p>To manually associate PDB files with a sequence, select 'From
 160     File', or 'Enter PDB Id' from the drop-down menu:
 161   <ul>
 162     <li><strong>From File</strong> - allows you to load a PDB file
 163       from the local machine or network and associate it with the
 164       selected sequence. PDB files associated in this way will also be
 165       saved in the <a href="jalarchive.html">Jalview Archive file</a>.<br></li>
 166     <li><strong>Enter PDB Id</strong> - allows you specify a PDB ID
 167       for your sequence. The PDB Rest API, provided by EMBL-EBI, is used
 168       to validate and fetch structure data.<br></li>
 169   </ul>
 170
 171   <p>
 172     <em>The Structure Chooser interface was introduced in Jalview
 173       2.9. </em>
 174   </p>
 175 </body>
 176 </html>