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