2.2 documentation
[jalview.git] / help / html / features / hiddenRegions.html
index 511d80e..c5266d7 100644 (file)
@@ -1,36 +1,53 @@
-<html>\r
-<head><title>Hidden Regions</title></head>\r
-<body>\r
-<p><strong>Hidden Regions</strong> </p>\r
-<p>To <strong>hide selected sequences </strong>from an alignment, use the &quot;View \r
-  -&gt; Hide -&gt; Selected Sequences&quot; menu item or simply select &quot;Hide \r
-  Sequences&quot; from the Popup menu after a right click on the sequence Ids. \r
-</p>\r
-<p>Hidden sequences will not be used in any calculations, editing or web service \r
-  alignments performed on visible sequences. </p>\r
-<p>A more advanced hide involves a right-mouse click on a sequence, then selecting \r
-  &quot;SequenceID -&gt; Represent Group with SequenceId&quot;. Using this method \r
-  of hiding sequences, any edits performed on the visible group representative \r
-  will be propogated to all the sequences in that group. <br>\r
-  The hidden sequences will not be used in any calculations or web service alignments. \r
-</p>\r
-<p>&nbsp;</p>\r
-<p>To <strong>hide selected columns</strong> from an alignment, use the &quot;View \r
-  -&gt; Hide -&gt; Selected Columns&quot; menu item, or right click within a region \r
-  of selected columns in the scale above the alignment (only available in non \r
-  wrapped mode) and select &quot;Hide Columns&quot;. </p>\r
-<p>Hidden columns will not be used in any calculations. This allows you to eg. \r
-  create trees from the visible alignment and ignore any poorly aligned sections \r
-  of the alignment, without cutting and deleting them permanently from your alignment.<br>\r
-  It is possible to retrieve the input data to any trees, PCA analysis windows \r
-  which were created from alignments containing hidden columns by using the &quot;File \r
-  -&gt; Input Data...&quot; menu item from the tree window. </p>\r
-<p> Editing the alignment is bound by the hidden columns, ie you cannot move residues \r
-  across a hidden column boundary.</p>\r
-<p>Any web service alignments performed on sequences which contain hidden columns \r
-  send the alignment as a series of chunks delimited by the hidden columns. </p>\r
-<p>&nbsp;</p>\r
-<p>&nbsp;</p>\r
-<p>&nbsp;</p>\r
-</body>\r
-</html>\r
+<html>
+<head><title>Hidden Regions</title></head>
+<body>
+<p><strong>Hidden Regions</strong> </p>
+<p>Use the keyboard key &quot;H&quot; to hide / reveal selected columns and sequences. 
+  To hide / reveal only selected sequences, use &quot;Shift H&quot;, to hide / 
+  reveal only selected columns, use &quot;Control H&quot;.</p>
+<p><strong><em>Hiding Sequences</em></strong><br>
+To hide selected sequences in an alignment, use the <strong>&quot;View 
+  -&gt; Hide -&gt; Selected Sequences&quot;</strong> menu item or simply select <strong>&quot;Hide 
+  Sequences&quot;</strong> from the Popup menu after a right click on the sequence Ids. 
+</p>
+<p>Hidden sequences will not be used in any calculations, editing or web service 
+  alignments performed on visible sequences. </p>
+<p><strong><em>Hidden Sequences Representatives</em></strong><br>
+A more advanced hide involves a right-mouse click on a sequence, then selecting 
+  <strong>&quot;SequenceID -&gt; Represent Group with SequenceId&quot;</strong>. Using this method 
+  of hiding sequences, any edits performed on the visible group representative 
+  will be propogated to all the sequences in that group. <br>
+  The hidden representative sequences will not be used in any
+  calculations or web service alignments (<em>nb. this may change in
+  the future</em>)
+</p>
+<p><strong><em>Hiding Columns</em></strong><br>
+To hide selected columns in an alignment, use the <strong>&quot;View 
+  -&gt; Hide -&gt; Selected Columns&quot;</strong> menu item, or right click within a region 
+  of selected columns in the scale above the alignment (only available in non 
+  wrapped mode) and select <strong>&quot;Hide Columns&quot;</strong>. </p>
+<p>When an alignment view contains hidden columns, certain constraints
+apply:<ul><li>Editing the alignment is bound by the hidden columns, <em>i.e.</em> you cannot move residues 
+  across a hidden column boundary.</li>
+<li><strong>Tree</strong>, <strong>pairwise alignment</strong> and <strong>PCA</strong> calculations will only be
+performed using the <em>visible</em> parts of the alignment.
+</li>
+<li><a
+  href="../webservices/msaclient.html">Multiple Sequence
+  Alignments</a> are performed locally on on each visible chunk of
+  the input, and concatenated with the hidden regions to form the
+  final result.</p>
+</li>
+</ul>
+<p><strong>Column Separability</strong><br>Calculations where hidden columns are
+  excluded, and a single analysis performed on the result, are termed <em>column-separable</em>.
+  The simple Tree and PCA calculations are column separable because essentially the same results
+  would be obtained if the excluded hidden columns were replaced by gaps as the input to the calculation.</p>
+  <p>Multiple Sequence alignment and secondary structure prediction are both non-column-separable, and 
+  so the exclusion of hidden regions leads to only 'locally optimal' results - sometimes 
+  different to that obtained when using the full alignment.</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+</body>
+</html>