help/html/features/columnFilterByAnnotation.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   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>From Jalview 2.9 columns of an alignment can be filtered using
  31                 any annotation row added to that alignment.</p>
  32         To carry out this operation, navigate to &quot;<b>Select</b><strong><b>&#8594;</b></strong><b>Select/Hide Columns by Annotation...</b>&quot; to bring
  33         up the 'Select/Hide by Annotation' window. The filter options vary depending
  34         on the type of annotation selected. If an annotation that has a numeric
  35         values is selected, the threshold filter option is activated as seen in the
  36         figure on the right below, otherwise the dialog will exclude the threshold filter option as seen in the figure on the left.
  37         <br>
  38         <br>
  39         <table>
  40                 <tr>
  41                         <td><img src="annotationColumnSelectionWithoutSM.gif"></td>
  42                         <td><img src="annotationColumnSelectionWithSM.gif"></td>
  43                 </tr>
  44         </table>
  45
  46
  47         <ul>
  48                 <li>The target annotation row can be selected using the drop-down option menu in the top-most part of the window.</li>
  49
  50                 <li><strong>Search Filter</strong>
  51                         <ul>
  52                                 <li>When a text is entered in the text box within the Search
  53                                         Filter section, the 'Display Label' and 'Description'
  54                                         options becomes enabled for selection. </li>
  55                                 <li>On selecting any of the options, a regular expression
  56                                         search (RegEx) is executed on the specified field of the current
  57                                         annotation row selected, and the matching columns will be highlighted
  58                                         in the alignment.</li>
  59                         </ul>
  60                 <li><strong>Structure Filter</strong>
  61                         <ul>
  62                                 <li>Alignment columns can also be filtered by the type of
  63                                         secondary structure present in a target annotation row.</li>
  64                                 <li>This can be achieved by ticking the type of structure you
  65                                         wish to filter by under the structures filter section.</li>
  66                         </ul>
  67                 <li><strong>Threshold Filter</strong>
  68                         <ul>
  69                                 <li>This filter is only activated for annotation which contain
  70                                         numeric values</li>
  71                                 <li>Select whether to filter the alignment above or below an
  72                                         adjustable threshold with the selection box within the threshold
  73                                         filter section.</li>
  74                                 <li>Change the threshold value with the slider, or enter the
  75                                         exact value in the text box.</li>
  76                         </ul>
  77                 <li><strong>Actions</strong>
  78                         <ul>
  79                                 <li>The 'Select' and 'Hide' radio buttons
  80                                         determines the action that will be carried out on the matching
  81                                         columns in the alignment during the filtering process.</li>
  82                                 <li>The default option is 'Select' and this simply
  83                                         enables column selection on the matching alignment column.</li>
  84                                 <li>While the 'Hide' option enables the matching columns to
  85                                         be hidden automatically during the filtering process.</li>
  86                                 <li>The 'Ok' button applies the filter when clicked.</li>
  87                                 <li>And finally, the 'Cancel' button restores the alignment to its previous state before any filtering was applied.
  88                         </ul></li>
  89         </ul>
  90
  91 </body>
  92 </html>