JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / help / html / colourSchemes / annotationColouring.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
4  * Copyright (C) 2015 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>Annotation Colouring</title>
24 </head>
25
26 <body>
27   <p>
28     <strong> Annotation Colouring </strong>
29   </p>
30   <p>Jalview allows the columns of an alignment to be coloured using
31     any numerical annotation rows added to that alignment.</p>
32   Select &quot;Colour&quot;
33   <strong>&#8594;</strong> &quot;.. by Annotation&quot; to bring up the
34   Colour by Annotation settings window.
35   <br>
36   <br>
37   <div align="center">
38     <img src="annotationColourSetting.gif" width="471" height="256">
39   </div>
40   <ul>
41     <li>Select which annotation to base the colouring scheme on
42       using the top left selection box.<br />If the <strong>Per-sequence
43         only</strong> tick box is not greyed out, then ticking it will limit the
44       available annotation rows to just those that are sequence
45       associated (e.g. T-COFFEE scores and <a
46       href="../webServices/proteinDisorder.html"
47     >protein disorder predictions</a>), which will colour each sequence
48       according to its own per-residue scores.<br /> <em>Per-sequence
49         associated annotation colouring was introduced in Jalview 2.8</em>
50     </li>
51     <li>If the &quot;Use Original Colours&quot; box is selected,
52       the colouring scheme will use the colouring scheme present on the
53       alignment before the Annotation Colour Settings window was
54       displayed. <br /> <em><strong>Please Note:</strong> If no
55         colour scheme was applied previously, then the colours for lines
56         and labels at each position in the annotation row will be used,
57         for secondary structure symbols and graphs, this may be black by
58         default, so your alignment will be coloured black.</em>
59     </li>
60     <li><em>Secondary structure annotation colouring</em><br />By
61       default, Jalview will employ the helix or sheet colours to shade
62       sequences and columns by available secondary structure annotation
63       tracks. In the case of RNA, each structure is processed to
64       identify distinct RNA helices and rendered in the same way as the
65       <a href="rnahelicesColouring.html">RNA Helices shading scheme</a>.
66       <em>Structure based sequence shading was added in Jalview
67         2.8.2</em></li>
68     <li>The colour scheme can display a colour gradient from a
69       colour representing the minimum value in the selected annotation
70       to a colour representing the maximum value in the selected
71       annotation. Use the &quot;Min Colour&quot; and &quot;Max
72       Colour&quot; to set the colour gradient range.
73       <ul>
74         <li>Press the &quot;Defaults&quot; button to reset the
75           minimum and maximum colours to their default settings (these
76           are configured in the applet's parameters or the <a
77           href="../features/preferences.html"
78         >application's user preferences</a>.).<br /> <em>Default min
79             and max colours were introduced in Jalview 2.7</em>
80       </ul>
81     </li>
82
83     <li>Select whether to colour the alignment above or below an
84       adjustable threshold with the selection box center left of the
85       window.</li>
86     <li>Change the threshold value with the slider, or enter the
87       exact value in the text box.</li>
88     <li>Select the &quot;Threshold is Min/Max&quot; checkbox to
89       assign colours using the thresholded range's minimum and maximum
90       values, otherwise the scale will be defined by the range of values
91       in the annotation row.</li>
92   </ul>
93   <p align="center">
94     <img src="annotationColours.gif" width="582" height="464">
95   </p>
96 </body>
97 </html>