source: branches/lib/HELP_SOURCE/source/species_join.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: 1.9 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6#SUB     subtopic.hlp
7
8# format described in ../help.readme
9
10
11TITLE           Join species
12
13OCCURRENCE      ARB_NT/Species/Merge Species/Join marked species
14
15DESCRIPTION
16
17            WARNING: This module is obsolete by newer modules. See NOTES below!
18
19            "Join species" merges several similar species into one species.
20
21            All database fields and the sequences get concatenated.
22
23            - Mark all species that should be examined for similarity.
24
25            - Select a database field entry from the list
26              to set a similarity-criterion used to detect
27              candidates for joining (for e.g., full_name).
28
29            - Check separators for fields and sequences.
30
31            - Press GO to start.
32
33EXAMPLES
34
35                For example you have a 23s and a 16s database and you want
36                to append the 16s to the 23s sequences than you have to do:
37
38                        - merge the 16s to the 23s sequences.
39
40                        - create a field 'species_name' which holds the
41                          real name of the species.
42                          That means the species_name of the 16s sequence
43                          should be the same as of the 23s seq.
44                          Do not use the 'name'-field because it is
45                          used as a UNIQUE id to the database.
46
47                        - ARB_NT/Species/Merge Species/Join Marked Species
48                          and use the field 'species_name'.
49
50
51NOTES           There's a second, newer function to merge species: see LINK{merge_species.hlp}
52
53                There's a special new function to concatenate alignments: see LINK{concatenate.hlp}
54
55WARNINGS        'Join marked species' does only merge fields of type STRING, all other fields are skipped
56                (taken from one of the joined species).
57
58BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.