Merge branch 'develop' into patch/JAL-4281_idwidthandannotHeight_in_project
[jalview.git] / help / help / html / colourSchemes / annotationColouring.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>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>You can also apply Colour by annotation for a particular annotation
37         (or per-sequence set) by right-clicking an annotation row's label and selecting &quot;Colour by Annotation...&quot; or &quot;Colour by Annotation (per Sequence)...&quot; from the 
38         <strong>Annotation label popup menu</strong>. (<em>Since Jalview 2.11.3</em>)
39         <br>
40   <div align="center">
41   <img src="../features/annotationsubmenucolbyannot.png" width="414" height="266">
42   </div>
43   <p><strong>The Colour by Annotation Settings Window</strong></p>
44   <br>
45   <div align="center">
46     <img src="annotationColourSetting.gif" width="471" height="256">
47   </div>
48   <ul>
49     <li>Select which annotation to base the colouring scheme on
50       using the top left selection box. Sequence associated alignment
51       annotation are shown with the seuqence's name appended.<br />If
52       the <strong>Per-sequence only</strong> tick box is not greyed out,
53       then ticking it will limit the list of available annotation rows
54       to just the labels for those that are sequence associated.
55       Annotation rows on each sequence with the same label (e.g.
56       T-COFFEE scores and <a href="../webServices/proteinDisorder.html">protein
57         disorder predictions</a>) will then be used to colour its
58       corresponding positions in the alignment.<br /> <em>Per-sequence
59         associated annotation colouring is currently only available in
60         the Desktop.</em>
61     </li>
62     <li>If the &quot;Use Original Colours&quot; box is selected,
63       the colouring scheme will use the colouring scheme present on the
64       alignment before the Annotation Colour Settings window was
65       displayed. <br /> <em><strong>Please Note:</strong> If no
66         colour scheme was applied previously, then the colours for lines
67         and labels at each position in the annotation row will be used,
68         for secondary structure symbols and graphs, this may be black by
69         default, so your alignment will be coloured black.</em>
70     </li>
71     <li><em>Secondary structure annotation colouring</em><br />By
72       default, Jalview will employ the helix or sheet colours to shade
73       sequences and columns by available secondary structure annotation
74       tracks. In the case of RNA, each structure is processed to
75       identify distinct RNA helices and rendered in the same way as the
76       <a href="rnahelicesColouring.html">RNA Helices shading scheme</a>.
77       <em>Structure based sequence shading was added in Jalview
78         2.8.2</em></li>
79     <li>The colour scheme can display a colour gradient from a
80       colour representing the minimum value in the selected annotation
81       to a colour representing the maximum value in the selected
82       annotation. Use the &quot;Min Colour&quot; and &quot;Max
83       Colour&quot; to set the colour gradient range.
84       <ul>
85         <li>Press the &quot;Defaults&quot; button to reset the
86           minimum and maximum colours to their default settings (these
87           are configured in the applet's parameters or the <a
88           href="../features/preferences.html">application's
89             user preferences</a>.).<br /> <em>Default min and max
90             colours were introduced in Jalview 2.7</em>
91       </ul>
92     </li>
93
94     <li>Select whether to colour the alignment above or below an
95       adjustable threshold with the selection box center left of the
96       window.</li>
97     <li>Change the threshold value with the slider, or enter the
98       exact value in the text box.</li>
99     <li>Select the &quot;Threshold is Min/Max&quot; checkbox to
100       assign colours using the thresholded range's minimum and maximum
101       values, otherwise the scale will be defined by the range of values
102       in the annotation row.</li>
103   </ul>
104   <p align="center">
105     <img src="annotationColours.gif" width="582" height="464">
106   </p>
107 </body>
108 </html>