source: trunk/HELP_SOURCE/source/keeled_groups.hlp

Last change on this file was 19532, checked in by westram, 5 weeks 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
File size: 3.8 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6SUB     mode_setroot.hlp
7SUB     syncroots.hlp
8SUB     mode_group.hlp
9
10# format described in ../help.readme
11
12
13TITLE           Keeled groups
14
15DESCRIPTION     Taxonomic groups in an unrooted tree(!) can be defined by
16                * the branch at which the group is located
17                * the direction into which the group points (i.e. which of
18                  the 2 subtrees that are connected by this branch does form
19                  the defined group)
20
21                In rooted trees the branch location on its own suffices as
22                group-defining criteria, if we assume all groups point away from
23                the root. This is the way taxonomic groups are handled in most
24                software and so did arb (up to version 6.0.6).
25
26                This simple handling of groups was not able to reflect the semantic change
27                which is implicitely applied by moving the trees root into a group.
28
29                To solve this problem, arb-7.0 introduced the concept of "keeled groups".
30
31                A keeled group may be interpreted in 2 (semantically equivalent) ways:
32                 * the keeled group "points upwards" (i.e. semantically it defines a taxonomic unit containing the two OTHER subtrees starting at its parent-node)
33                 * the keeled group "graphically embraces the inverse subset of species" compared with the original unkeeled group
34
35                To indicate keeled groups, their names are prefixed by exclamation
36                marks, e.g. shown as '!group' which should be read as "not group";
37                this emphasizes the 2nd interpretation given above.
38
39                Example:
40
41                        When the root of the tree is placed somewhere inside a
42                        group named 'Bacteria', that group gets keeled over.
43                        Its name now gets displayed as '!Bacteria' (should read
44                        as "not Bacteria") and the group does embrace the rest
45                        of the tree, i.e. "everything but Bacteria".
46
47
48NOTES           Two groups with different orientation (i.e. a normal and a
49                keeled group) may appear at the same inner node.
50                This happens e.g. when the original tree had groups defined
51                at both subtrees starting directly at root.
52                The group name of such a group will be "Normal = !Keeled".
53
54SECTION         Howto 'fix' keeled groups
55
56                It's not possible to export keeled groups into newick files!
57
58                If a tree contains keeled groups, there is a mismatch between
59                    - the taxonomy defined by the groups in the tree and
60                    - the position of the tree-root.
61
62                One reason for that mismatch is a misplaced tree-root.
63                In that case there exists at least one root-position where no
64                groups are keeled.
65                To find such a position use LINK{mode_setroot.hlp} and
66                repeatedly click on any keeled group you spot,
67                until they've all disappeared.
68
69                If they won't disappear, the taxonomy of the tree probably is
70                not well-defined and has to be resolved manually.
71                In that case the following tools may help:
72
73                    - right click onto a keeled group in LINK{mode_group.hlp} to
74                      toggle its keeled state,
75                    - afterwards use LINK{mode_move.hlp} to correct the position
76                      of that group OR
77                    - delete a keeled group, if it does no longer fit into the tree.
78                      This might e.g. apply after topology changes.
79
80EXAMPLES        None
81
82WARNINGS        None
83
84BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.