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