help/help/html/features/featureschemes.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>Sequence feature colour schemes</title>
  24 </head>
  25
  26 <body>
  27   <p>
  28     <strong>Visualisation of Sequence Features</strong>
  29   </p>
  30         <p>Jalview can visualize sequence features - the positional
  31                 annotation present on parts of a sequence, as colours overlaid on
  32                 corresponding positions in the alignment. Features may be coloured
  33                 either according to their type, or for a particular type, according to
  34                 each feature's associated label, score, or other attributes.</p>
  35         <p>
  36                 The <a href="featuresettings.html">Feature Settings dialog box</a>
  37                 controls the order and display of each feature type, and
  38                 also allows filters and colour schemes to be configured.
  39         </p>
  40
  41
  42         <div align="center">
  43                 <img src="featureDisplaySettings.png" /><br />
  44                 <em>Feature Display Settings dialog for 'sequence_variant'
  45                         features imported from VCF</em>
  46         </div>
  47         <p>The Feature Display Settings has the following controls:
  48         <p><strong>Colour</strong></p>
  49         <ul>
  50                 <li><em>Simple Colour</em> - select this to assign a given colour
  51                         to any features of this type. The assigned colour can be changed by
  52                         clicking on the colour box.</li>
  53                 <li><em>Colour by text</em> - this option derives a colour for
  54                         each feature based on its label, or any other attributes presented <em>via</em>
  55                         the drop-down menu.</li>
  56                 <li><em>Graduated Colour</em> - shade features according to
  57                         associated score, or other numeric attribute.
  58                         <ul>
  59                                 <li><em>Min and Max Color boxes</em> - Click on these boxes to
  60                                         set the minimum and maximum colours for the shading scheme.</li>
  61                                 <li><em>Threshold type combo box</em> - Specify an exclusion
  62                                         threshold.<br />Set the threshold using the slider or
  63                                                 type it in to the text box. The threshold cannot be set outside
  64                                                 the available range of values observed for the selected attribute.</li>
  65                                 <li><em>Threshold is Min/Max</em> - When checked, the threshold
  66                                         will be used as the upper or lower limit for shading using the Min
  67                                         and Max colour.</li>
  68                         </ul></li>
  69         </ul>
  70         <p>
  71                 <strong><em>Filters</em></strong><br /> Any number of filter
  72                 conditions may be specified to select features based on one or more
  73                 attributes. The <strong>join</strong> condition specifies whether all
  74                 filters must apply (<strong><em>And</em></strong>) or whether any one
  75                 filter must apply (<strong><em>Or</em></strong>) for a feature to be
  76                 selected.
  77         </p>
  78         <p>The filters available depend on the type of attribute:</p>
  79         <ul>
  80                 <li><strong>Numeric</strong> - specify a threshold above, equal
  81                         to or below which a feature will be selected or ignored.</li>
  82                 <li><strong>String</strong> - select or ignore features based on
  83                         presence, absence, equivalence, or containment of a string (not case sensitive).</li>
  84         </ul>
  85         <p>
  86                 The filters and colour schemes active for a particular feature type
  87                 are shown in the <em>Colour</em> and <em>Configuration</em> columns in
  88                 the feature settings dialog. Styles and filters can be saved as a
  89                 Jalview Feature Colours file, and are also exported and imported via <a
  90                         href="featuresFormat.html">Jalview Feature files</a>.
  91
  92         <p>
  93                 <strong>Icon styles for feature rendering styles</strong><br />
  94
  95         <p>
  96                 When a graduated colour scheme is applied to a feature according to
  97                 the value of a particular attribute, it is indicated in the feature
  98                 settings or amend feature dialog box by the following types of icon:<br />
  99
 100         <div align="center">
 101                 <table width="50%" border="1">
 102                         <tr>
 103                                 <td><strong>Type of Colouring</strong></td>
 104                                 <td><strong>Icon</strong></td>
 105                         </tr>
 106                         <tr>
 107                                 <td><em>Graduated colour by Feature Score</em></td>
 108                                 <td><img src="fcsminmax.gif" /></td>
 109                         </tr>
 110                         <tr>
 111                                 <td><em>Graduated colour thresholded (less than) by
 112                                                 feature Score (or other attribute)</em></td>
 113                                 <td><img src="fcsltthan.gif" /></td>
 114                         </tr>
 115                         <tr>
 116                                 <td><em>Graduated colour thresholded (greater than) by
 117                                                 feature Score (or other attribute)</em></td>
 118                                 <td><img src="fcsgtthan.gif" /></td>
 119                         </tr>
 120                         <tr>
 121                                 <td><em>Colour by Feature Label</em></td>
 122                                 <td><img src="fcsntlabel.gif" /></td>
 123                         </tr>
 124                         <tr>
 125                                 <td align="center" colspan="2"><em> <strong>The
 126                                                         current threshold and attribute is shown in the icon's tooltip.</strong>
 127                                 </em></td>
 128                         </tr>
 129                 </table>
 130         </div>
 131         </p>
 132         <em>Graduated feature colours were introduced in Jalview 2.5.
 133                 Attribute based colouring and filters were added in Jalview 2.11.</em>
 134 </body>
 135 </html>