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