source: trunk/HELP_SOURCE/source/realign_dna.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
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.1 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6SUB     translate_dna_2_pro.hlp
7
8# format described in ../help.readme
9
10
11TITLE           Realign DNA
12
13OCCURRENCE      ARB_NT/Sequence/Align sequences/Realign DNA according to aligned protein
14
15DESCRIPTION     If you have translated DNA sequences into protein sequences and then have aligned
16                the resulting protein sequences, this function can be used to re-align the
17                DNA sequences according to the (modified) protein alignment.
18
19                Select the protein and the corresponding DNA alignment.
20
21                Press 'REALIGN' to re-align the DNA sequences of all marked species.
22
23SECTION         Options
24
25                The length of the DNA alignment has to be at least 3 times the length of the
26                protein alignment. If it is shorter, the realigner will automatically increase
27                the length if 'Increase DNA alignment size if needed' is checked. Otherwise
28                it will abort with error.
29
30                By checking 'Unmark successfully realigned species' you can control whether to leave
31                all species marked or only species failing to realign, which might be helpful to
32                examine and fix failure reasons.
33
34                If your DNA alignment has some extra DNA beyond one or both ends of the part
35                coding the protein alignment, the ARB realigner will still be able to find
36                and realign the coding part properly.
37                The extra DNA can either
38                * be appended adjacent to the coding part (if there is enough space) or
39                * be cut off.
40
41                You can control that behavior by checking 'Cut-off superfluous DNA'.
42
43SECTION         Fields 'transl_table' and 'codon_start'
44
45                If the species contains a field 'transl_table' (which should contain the translation table
46                number as used by the EMBL database) it is used to detect the correct translation table.
47                If no such field is defined a translation-table-auto-detection takes place.
48
49                If the species contains a field 'codon_start' it is overwritten with '1' in order to make
50                further translations of the realigned DNA work properly.
51
52                Either both fields ('transl_table' and 'codon_start') or none of them has to exist.
53                Otherwise an error occurs and you have to correct these fields manually (e.g. by
54                using the search tool and 'Write to fields of listed' or by deleting these fields).
55
56                After successful re-alignment the field 'codon_start' will be set to '1' if
57                - it already existed before or
58                - if ARB was able to strictly determine a content for the field 'transl_table'
59                  (which will also be written in that case).
60
61                If the re-alignment was possible using two or more different translation tables
62                neither 'transl_table' nor 'codon_start' will be written.
63
64NOTES           Please note LINK{aaali.hlp}
65
66EXAMPLES        None
67
68WARNINGS        None
69
70BUGS            No bugs known
71
Note: See TracBrowser for help on using the repository browser.