JAL-1066 documentation for per-sequence annotation colouring
[jalview.git] / help / html / colourSchemes / annotationColouring.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
4  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
11  * 
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18 -->
19 <head>
20 <title>Annotation Colouring</title>
21 </head>
22
23 <body>
24         <p>
25                 <strong> Annotation Colouring </strong>
26         </p>
27         <p>Jalview allows the columns of an alignment to be coloured using
28                 any numerical annotation rows added to that alignment.</p>
29         Select &quot;Colour&quot;
30         <strong>&#8594;</strong> &quot;.. by Annotation&quot; to bring up the
31         Colour by Annotation settings window.
32         <br>
33         <br>
34         <div align="center">
35                 <img src="annotationColourSetting.gif" width="471" height="256">
36         </div>
37         <ul>
38                 <li>Select which annotation to base the colouring scheme on using
39                         the top left selection box.<br />If the <strong>Per-sequence
40                                 only</strong> tick box is not greyed out, then ticking it will limit the
41                         available annotation rows to just those that are sequence associated
42                         (e.g. T-COFFEE scores and <a
43                         href="../webServices/proteinDisorder.html">protein disorder
44                                 predictions</a>), which will colour each sequence according to its own
45                         per-residue scores.<br />
46                 <em>Per-sequence associated annotation colouring was introduced
47                                 in Jalview 2.8</em>
48                 </li>
49                 <li>The colour scheme can display a colour gradient from a colour
50                         representing the minimum value in the selected annotation to a colour
51                         representing the maximum value in the selected annotation. Use the
52                         &quot;Min Colour&quot; and &quot;Max Colour&quot; to set the colour
53                         gradient range.
54                         <ul>
55                                 <li>Press the &quot;Defaults&quot; button to reset the minimum
56                                         and maximum colours to their default settings (these are configured
57                                         in the applet's parameters or the <a
58                                         href="../features/preferences.html">application's user
59                                                 preferences</a>.).<br />
60                                 <em>Default min and max colours were introduced in Jalview 2.7</em>
61                         </ul>
62                 </li>
63
64                 <li>Select whether to colour the alignment above or below an
65                         adjustable threshold with the selection box center left of the
66                         window.</li>
67                 <li>Change the threshold value with the slider, or enter the
68                         exact value in the text box.</li>
69                 <li>Select the &quot;Threshold is Min/Max&quot; checkbox to
70                         assign colours using the thresholded range's minimum and maximum
71                         values, otherwise the scale will be defined by the range of values in
72                         the annotation row.</li>
73         </ul>
74         <p align="center">
75                 <img src="annotationColourView.gif" width="581" height="148">
76         </p>
77 </body>
78 </html>