update author list in license for (JAL-826)
[jalview.git] / help / html / features / hiddenRegions.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>Hidden Regions</title>
21 </head>
22 <body>
23 <p><strong>Hidden Regions</strong></p>
24 <p>Use the keyboard key &quot;H&quot; to hide / reveal selected
25 columns and sequences. To hide / reveal only selected sequences, use
26 &quot;Shift H&quot;, to hide / reveal only selected columns, use
27 &quot;Control H&quot;. You can also use &quot;Shift&quot; and
28 &quot;Control&quot; together to hide everything but the currently
29 selected region.</p>
30 <p><strong><em>Hiding Sequences</em></strong><br>
31 To hide selected sequences in an alignment, use the <strong>&quot;View
32 -&gt; Hide -&gt; Selected Sequences&quot;</strong> menu item or simply select <strong>&quot;Hide
33 Sequences&quot;</strong> from the Popup menu after a right click on the sequence
34 Ids.</p>
35 <p>Hidden sequences will not be used in any calculations, editing or
36 web service alignments performed on visible sequences.</p>
37 <p><strong><em>Hidden Sequences Representatives</em></strong><br>
38 A more advanced hide involves a right-mouse click on a sequence, then
39 selecting <strong>&quot;SequenceID -&gt; Represent Group with
40 SequenceId&quot;</strong>. Using this method of hiding sequences, any edits
41 performed on the visible group representative will be propogated to all
42 the sequences in that group. <br>
43 The hidden representative sequences will not be used in any calculations
44 or web service alignments (<em>nb. this may change in the future</em>).
45 <p><strong><em>Hidden Sequence Representatives and
46 Multiple Views</em></strong><br>
47 <em>A word of warning: hidden representative sequence groups are
48 (still) only partly implemented in the jalview 2.5 release, and we hope
49 to deal with the following issues in the future.</em><br>
50 Currently, represented hidden groups are only made correctly if there is
51 just one alignment view. When multiple views on an alignment exist, then
52 the represented group will be displayed correctly in the view in which
53 it was made, but in other views, both representative and hidden
54 sequences will be visible, but will behave as if they are grouped. <br>
55 Hidden representatives are propagated correctly to a new view if they
56 exist in the current view. However, if the represented sequences are
57 revealed in any one view, then in all other views they will simply be
58 marked as hidden, and their association with the representative sequence
59 will be lost.<br>
60 </blockquote>
61 </p>
62 <p><strong><em>Hiding Columns</em></strong><br>
63 To hide selected columns in an alignment, use the <strong>&quot;View
64 -&gt; Hide -&gt; Selected Columns&quot;</strong> menu item, or right click within
65 a region of selected columns in the scale above the alignment (only
66 available in non wrapped mode) and select <strong>&quot;Hide
67 Columns&quot;</strong>.</p>
68 <p>When an alignment view contains hidden columns, certain
69 constraints apply:
70 <ul>
71         <li>Editing the alignment is bound by the hidden columns, <em>i.e.</em>
72         you cannot move residues across a hidden column boundary.</li>
73         <li><strong><a href="../calculations/tree.html">Tree</a></strong>,
74         <strong><a href="../calculations/pairwise.html">pairwise
75         alignment</a></strong> and <strong><a href="../calculations/pca.html">PCA</a></strong>
76         calculations will only be performed using the <em>visible</em> parts of
77         the alignment.</li>
78         <li><a href="../webservices/msaclient.html">Multiple Sequence
79         Alignments</a> are performed locally on on each visible chunk of the input,
80         and concatenated with the hidden regions to form the final result.
81 </p>
82 </li>
83 </ul>
84 <p><strong>Column Separability</strong><br>
85 Calculations where hidden columns are excluded, and a single analysis
86 performed on the result, are termed <em>column-separable</em>. The
87 simple Tree and PCA calculations are column separable because
88 essentially the same results would be obtained if the excluded hidden
89 columns were replaced by gaps as the input to the calculation.</p>
90 <p>Multiple Sequence alignment and secondary structure prediction
91 are both non-column-separable, and so the exclusion of hidden regions
92 leads to only 'locally optimal' results - sometimes different to that
93 obtained when using the full alignment.</p>
94 <p>&nbsp;</p>
95 <p>&nbsp;</p>
96 <p>&nbsp;</p>
97 </body>
98 </html>