help/html/features/columnFilterByAnnotation.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>Select/Hide Columns by Annotation</title>
  24 </head>
  25
  26 <body>
  27   <p>
  28     <strong>Select/Hide Columns by Annotation</strong>
  29   </p>
  30   <p>
  31     The 'Select/Hide by Annotation' window allows columns to be selected
  32     or hidden according to annotation rows on the alignment. The dialog
  33     box is opened <em>via</em> &quot;<strong>Select&#8594;Select/Hide
  34       Columns by Annotation...</strong>&quot;, and different filters are
  35     presented dependent upon the data shown in the selected annotation row.
  36   </p>
  37   <table>
  38     <tr>
  39       <td><img src="annotationColumnSelectionWithSM.gif"></td>
  40       <td><img src="annotationColumnSelectionWithoutSM.gif"></td>
  41     </tr>
  42   </table>
  43
  44   <p>If an annotation with numeric values is selected, the
  45     threshold filter option is activated. For other types of annotation,
  46     use the text box and secondary structure check boxes (right). The
  47     radio buttons at the bottom of the dialog specify the action applied
  48     to columns matching the query.</p>
  49   <ul>
  50     <li><strong>Search Filter</strong>
  51       <ul>
  52         <li>Enter text or regular expressions in the text box to
  53           activate the 'Display Label' and 'Description' options.</li>
  54         <li>Selecting the description or label options will
  55           activate the filter, and any matching columns will be
  56           highlighted or hidden.</li>
  57       </ul>
  58     <li><strong>Structure Filter</strong>
  59       <ul>
  60         <li>Select the checkboxes to filter by secondary structure
  61           type.</li>
  62       </ul>
  63     <li><strong>Threshold Filter</strong>
  64       <ul>
  65         <li>This filter is only activated for annotation which
  66           contain numeric values</li>
  67         <li>Select whether to filter the alignment above or below
  68           the threshold.</li>
  69         <li>Change the threshold value with the slider, or enter it
  70           in the text box.</li>
  71       </ul>
  72     <li><strong>Actions</strong>
  73       <ul>
  74         <li>'Select' (the default), selects columns matching the
  75           query settings.</li>
  76         <li>'Hide' causes matching columns to be hidden.</li>
  77       </ul></li>
  78   </ul>
  79   <p>Hit 'Cancel' to restore the alignment view to its previous
  80     state before any filtering was applied.</p>
  81 </body>
  82 </html>