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 then
  35     presented for filtering data according to the selected annotation
  36     row.
  37   </p>
  38   <table>
  39     <tr>
  40       <td><img src="AnnotationColumnSelectionWithSM.png"></td>
  41       <td><img src="AnnotationColumnSelectionWithoutSM.gif"></td>
  42     </tr>
  43   </table>
  44   <p>The drop down menu lists the annotation available on the
  45     alignment. Sequence associated annotation rows will be shown with
  46     the sequence ID appended to the annotation label. It is only
  47     possible to select one row at a time.</p>
  48   <p>
  49     If an annotation with numeric values is selected, the threshold
  50     filter option is activated. For other types of annotation, use the
  51     text box and secondary structure check boxes (right). The radio
  52     buttons at the bottom of the dialog specify the action applied to
  53     columns matching the query.<br /> <em>Note: annotation
  54       containing only numeric labels (e.g. T-COFFEE column confidence
  55       scores) will not be treated as quantitative data. You will need to
  56       enter search expressions to select columns in this case.</em>
  57   </p>
  58   <ul>
  59     <li><strong>Search Filter</strong>
  60       <ul>
  61         <li>Enter text or regular expressions in the text box to
  62           activate the 'Display Label' and 'Description' options.</li>
  63         <li>Selecting the description or label options will
  64           activate the filter, and any matching columns will be
  65           highlighted or hidden.</li>
  66       </ul>
  67     <li><strong>Structure Filter</strong>
  68       <ul>
  69         <li>Select the checkboxes to filter by secondary structure
  70           type.</li>
  71       </ul>
  72     <li><strong>Threshold Filter</strong>
  73       <ul>
  74         <li>This filter is only activated for annotation which
  75           contain numeric values</li>
  76         <li>Select whether to filter the alignment above or below
  77           the threshold.</li>
  78         <li>Change the threshold value with the slider, or enter it
  79           in the text box.
  80         <li>The <em>As Percentage</em> checkbox allows thresholds to
  81           be set as a percentage rather than absolute value.</li>
  82       </ul>
  83     <li><strong>Actions</strong>
  84       <ul>
  85         <li>'Select' (the default), selects columns matching the
  86           query settings.</li>
  87         <li>'Hide' causes matching columns to be hidden.</li>
  88       </ul></li>
  89   </ul>
  90   <p>Hit 'Cancel' to restore the alignment view to its previous
  91     state before any filtering was applied.</p>
  92 </body>
  93 </html>