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