JAL-1517 copyright and formatting
[jalview.git] / help / html / colourSchemes / annotationColouring.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
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
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 using
42                         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 associated
45                         (e.g. T-COFFEE scores and <a
46                         href="../webServices/proteinDisorder.html">protein disorder
47                                 predictions</a>), which will colour each sequence according to its own
48                         per-residue scores.<br />
49                 <em>Per-sequence associated annotation colouring was introduced
50                                 in Jalview 2.8</em>
51                 </li>
52                 <li>If the &quot;Use Original Colours&quot; box is selected, the
53                         colouring scheme will use the colouring scheme present on the
54                         alignment before the Annotation Colour Settings window was displayed.
55                         <br /> <em><strong>Please Note:</strong> If no colour scheme was
56                                 applied previously, then the colours for lines and labels at each
57                                 position in the annotation row will be used, for secondary structure
58                                 symbols and graphs, this may be black by default, so your alignment
59                                 will be coloured black.</em>
60                 </li>
61                 <li>The colour scheme can display a colour gradient from a colour
62                         representing the minimum value in the selected annotation to a colour
63                         representing the maximum value in the selected annotation. Use the
64                         &quot;Min Colour&quot; and &quot;Max Colour&quot; to set the colour
65                         gradient range.
66                         <ul>
67                                 <li>Press the &quot;Defaults&quot; button to reset the minimum
68                                         and maximum colours to their default settings (these are configured
69                                         in the applet's parameters or the <a
70                                         href="../features/preferences.html">application's user
71                                                 preferences</a>.).<br />
72                                 <em>Default min and max colours were introduced in Jalview 2.7</em>
73                         </ul>
74                 </li>
75
76                 <li>Select whether to colour the alignment above or below an
77                         adjustable threshold with the selection box center left of the
78                         window.</li>
79                 <li>Change the threshold value with the slider, or enter the
80                         exact value in the text box.</li>
81                 <li>Select the &quot;Threshold is Min/Max&quot; checkbox to
82                         assign colours using the thresholded range's minimum and maximum
83                         values, otherwise the scale will be defined by the range of values in
84                         the annotation row.</li>
85         </ul>
86         <p align="center">
87                 <img src="annotationColours.gif" width="582" height="464">
88         </p>
89 </body>
90 </html>