help/html/calculations/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>Filter Columns by Annotation</title>
  24 </head>
  25
  26 <body>
  27         <p>
  28                 <strong> Filter Columns by Annotation </strong>
  29         </p>
  30         <p>Jalview allows the columns of an alignment to be filtered using
  31                 any annotation rows added to that alignment.</p>
  32         From &quot;Select&quot; menu
  33         <strong>&#8594;</strong> &quot;Select by Annotation...&quot; to bring
  34         up the Select by Annotation window. The filter options vary depending
  35         on the type of annotation selected. If an annotation that has a numeric
  36         values is selected, the threshold filter option is activated as seen in the
  37         figure on the right below.
  38         <br>
  39         <br>
  40
  41         <div style="width: 48%; float: left; margin-left: 4%">
  42                 <img src="annotationColumnSelectionWithoutSM.gif">
  43         </div>
  44         <div style="width: 48%; float: right">
  45                 <img src="annotationColumnSelectionWithSM.gif">
  46         </div>
  47         <div>&nbsp</div>
  48
  49         <ul>
  50                 <li>Select which annotation to base the filtering on using the
  51                         top-most selection box.</li>
  52
  53                 <li><strong>Search Filter</strong>
  54                         <ul>
  55                                 <li>When a text is entered in the textfield on the search
  56                                         filter section, the &quot;Display Label&quot; and &quot;Description&quot;
  57                                         checkboxes becomes selectable.</li>
  58                                 <li>On selecting any of the checkboxes, a regular expresion
  59                                         search (RegEx) is executed on the specified field of the current
  60                                         annotation row selected, and the matching columns will be highlighted
  61                                         in the alignment.</li>
  62                         </ul>
  63                 <li><strong>Structure Filter</strong>
  64                         <ul>
  65                                 <li>Alignment columns can also be filtered by the type of
  66                                         secondary structure present in a choosen annotation row.</li>
  67                                 <li>This can be achieved by ticking the type of structure you
  68                                         wish to filter by under the structures filter section.</li>
  69                         </ul>
  70                 <li><strong>Threshold Filter</strong>
  71                         <ul>
  72                                 <li>This filter is only activated for annotation which contain
  73                                         numeric values</li>
  74                                 <li>Select whether to Filter the alignment above or below an
  75                                         adjustable threshold with the selection box within the threshold
  76                                         filter section.</li>
  77                                 <li>Change the threshold value with the slider, or enter the
  78                                         exact value in the text box.</li>
  79                         </ul>
  80                 <li><strong>Actions</strong>
  81                         <ul>
  82                                 <li>The &quot;Select&quot; and &quot;Hide&quot; radio buttons
  83                                         determines the action that will be carried out on the matching
  84                                         columns in the alignment during the filtering process.</li>
  85                                 <li>The default option is &quot;Select&quot; and this simply
  86                                         enables column selection on the matching alignment column.</li>
  87                                 <li>While the &quot;Hide&quot; option enables the matching columns to
  88                                         be hidden automatically during the filtering process.</li>
  89                                 <li>The &quot;Ok&quot; button applies the filter when clicked.</li>
  90                                 <li>And finally, The &quot;Cancel&quot; button restores the alignment to its previous state before the filtering when clicked.
  91                         </ul></li>
  92         </ul>
  93
  94 </body>
  95 </html>