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