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         The Structure Chooser interface provides a smart technique for
  32         selecting PDB structures to view in Jalview by querying readily
  33         available meta-data of structures. The Interface  can be invoked by selecting
  34         the
  35         <strong>"View Structure"</strong> option from a sequence's
  36         <a href="../menus/popupMenu.html">pop-up menu</a>. Some of the main
  37         features it provides are listed below:
  38         <ul>
  39                 <li>Automatic discovery, retrieval and association of PDB entries
  40                         for an alignment's sequences</li>
  41                 <li>Visualisation of discovered structures' meta-data</li>
  42                 <li>Ability to configure the meta-data entries to visualise</li>
  43                 <li>Auto-selection of the best structure via filtering by the
  44                         available metric parameters in the meta-data (i.e. resolution,
  45                         quality etc).</li>
  46                 <li>Selection of multiple structures in a single operation</li>
  47         </ul>
  48         Additionally, the Structure Chooser retains the following contemporary
  49         features of Jalview:
  50         <ul>
  51                 <li>Manual association of PDB entries via entering the PDB Id or
  52                         From File</li>
  53                 <li>Ability to view cached PDB entries</li>
  54         </ul>
  55
  56
  57         <strong>Associating PDB files with Sequences</strong><br>
  58         Discovery/Association of PDB entries to a sequence now happens
  59         automatically during the initialisation of the Structure Chooser
  60         Interface. Jalview uses the sequence's ID to query the PDB Rest API
  61         provided by the EBI to discover PDB Ids associated with the sequence.
  62
  63 <br><br>
  64         <strong>Configuring displayed  meta-data for  Structures</strong><br>
  65         To configure the visible meta-data displayed for the discovered structures, click the 'Configure Displayed Columns' tab, then tick the options which you intend to make visible.
  66
  67 <br><br>
  68         <strong>Auto-selection of best Structures</strong>
  69         <br> Jalview can automatically filter and select the best structures using various metric categories avaialble from the meta-data
  70         of the structures. To perform this simply select any of the following options from the drop-down menu in the Structure
  71         Chooser interface: Best Uniprot coverage, Higest Resolution,
  72         Best Quality, Highest Protein Chain etc. When the 'Invert' option is selected, Jalview returns an inverse result for the current selected option in the drop-down menu.<p>
  73
  74                 <img src="schooser_main.png" style="width: 464px; height: 369px;">
  75                 <!-- <p><img src="schooser_config.png" style="width: 463px; height: 369px; ">
  76         <p><img src="schooser_drop-down.png" style="width: 464px; height: 368px; ">
  77         <p><img src="schooser_enter-id.png" style="width: 467px; height: 373px; ">
  78         <p><img src="schooser_from-file.png" style="width: 468px; height: 370px; ">
  79         <p><img src="schooser_cached.png"> -->
  80                 <br>The screenshot above shows the Structure Chooser interface
  81                 along with the meta-data of auto-discovered structures for the sample
  82                 alignment. Note however that if no structures were auto-discovered, a
  83                 different interface for manual association will be invoked as seen in
  84                 the screenshot below.
  85         <p>
  86                 <img src="schooser_enter-id.png" style="width: 464px; height: 369px;">
  87         <p>
  88                 <strong>Manual selection/association of PDB files with Sequences</strong>
  89         </p>
  90         <p>To manually associate PDB files with a sequence, select any of
  91                 the follwing options listed below from the drop-down menu in the
  92                 interface:
  93         <ul>
  94                 <li><strong>From File</strong> - You can load a PDB file from the
  95                         local machine or network and associate it with the selected sequence.
  96                         PDB files associated in this way will also be saved in the <a
  97                         href="jalarchive.html">Jalview Archive file</a>.<br></li>
  98                 <li><strong>Enter PDB Id</strong> - Jalview will use the PDB Rest
  99                         API, provided by the EBI, to fetch the PDB file with the entered Id.<br>
 100                 </li>
 101                 <li><strong>Cached PDB Entries</strong> - You can view PDB structures which have previously been downloaded/viewed using this option. Jalview caches  previously downloaded PDB entries in the computer memory. However, if the project is saved before exiting Jalview, Jalview will serialize the cached entries to the file system. </li>
 102         </ul>
 103
 104         <p>
 105                 <em>The Structure Chooser interface was introduced in Jalview 2.9.
 106                 </em>
 107         </p>
 108 </body>
 109 </html>