source: branches/lib/HELP_SOURCE/source/sel_fil.hlp

Last change on this file was 19532, checked in by westram, 4 months ago
  • reintegrates 'help' into 'trunk'
    • tweak arb documentation:
      • automatically link
        • ticket references to arb bug tracker (only affects html version).
        • found URLs.
      • page titles
        • warn about long titles.
        • introduce SUBTITLEs (automatically triggered by multi-line titles in source files).
        • increase allowed length (limited by subwindow width).
      • cleanup header sections in all helpfiles.
      • fix and/or update several help files.
      • document syntax of help sources.
      • build issues:
        • when xml validation fails, next build no longer uses invalid xml ⇒ keeps failing.
        • remove output files on error (including files below ARBHOME/lib).
        • pipe output through logs to ensure proper wrapping in Entering/Leaving lines.
    • moves Tree admin + NDS menu entries to top of menu
  • adds: log:branches/help@18783:19531
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.2 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      extended.hlp
5
6#       sub topics:
7SUB     selected.hlp
8
9# format described in ../help.readme
10
11
12TITLE           Select Filter
13
14OCCURRENCE      ARB_NT/Tree/Neighbour joining/Select Filter
15
16DESCRIPTION     Any sequence of symbols stored as 'sequence associated
17                information' ('SAI') can be selected from the 'Select a Filter'
18                subwindow and used as a filter for the in or exclusion of
19                alignment columns for treeing.
20                If any species is selected, you may use it's sequence for
21                filter. It's name will be displayed just before the SAI names.
22
23                The characters of the filter which define columns to exclude
24                have to be defined in the respective input field.
25
26                Additionally or alternatively you may define the absolute column
27                range to be used (a range from 0 to 0 means 'use whole sequence').
28
29                The selected filter is displayed in the subwindow on the bottom.
30
31                All bases may be simplified, leaving only transversions
32                and simplified amino-acid-groups, allowing transversion
33                parsimony/fdnaml/distmethods
34
35NOTES           Any nucleotide sequence can be copied to SAI (sequence
36                associated information) (ARB_NT/Species/Info/SPECIES/Convert to
37                SAI) and then used as a filter.
38
39                Multiple filters may be combined. In this case only those columns
40                are used that are selected by ALL filters.
41
42EXAMPLES        Include only positions which are occupied by a residue within
43                the E. coli sequence:
44
45                        1. Select 'ECOLI' from the 'Select a Filter' subwindow.
46
47                        2. Type non-nucleotide symbols to the 'Exclude Column'
48                                subwindow (.-).
49
50                Include only non-base paired positions:
51
52                        1. Select 'HELIX' from the 'Select a Filter' subwindow.
53
54                        2. Type base pair symbols to the 'Exclude Column'
55                                subwindow ([<>]).
56
57                Include only positions which have been unambiguously determined
58                within a particular sequence:
59
60                        1. Select the species and convert it to 'SAI'
61                           using LINK{sp_sp_2_ext.hlp}.
62
63                        2. Select the new 'SAI' from the 'Select a Filter'
64                                subwindow.
65
66                        3. Type non-nucleotide and ambiguity symbols to the
67                                'Exclude Column' subwindow (.-acguRYS ....).
68
69WARNINGS        None
70
71BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.