← Back to branch summary

~ubuntu-branches/debian/jessie/arb/jessie

« back to all changes in this revision

Viewing changes to HELP_SOURCE/oldhelp/next_neighbours_common.hlp

  • Committer: Package Import Robot
  • Author(s): Elmar Pruesse, Andreas Tille, Elmar Pruesse
  • Date: 2014-09-02 15:15:06 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20140902151506-jihq58b3iz342wif
Tags: 6.0.2-1
http://bugs.debian.org/741890
http://bugs.debian.org/757497
[ Andreas Tille ]
* New upstream version
  Closes: #741890
* debian/upstream -> debian/upstream/metadata
* debian/control:
   - Build-Depends: added libglib2.0-dev
   - Depends: added mafft, mrbayes
* debian/rules
   - Add explicite --remove-section=.comment option to manual strip call
* cme fix dpkg-control
* arb-common.dirs: Do not create unneeded lintian dir
* Add turkish debconf translation (thanks for the patch to Mert Dirik
  <mertdirik@gmail.com>)
  Closes: #757497

[ Elmar Pruesse ]
* patches removed:
   - 10_config.makefiles.patch,
     80_no_GL.patch
       removed in favor of creating file from config.makefile.template via 
       sed in debian/control
   - 20_Makefile_main.patch
       merged upstream
   - 21_Makefiles.patch
       no longer needed
   - 30_tmpfile_CVE-2008-5378.patch: 
       merged upstream
   - 50_fix_gcc-4.8.patch:
       merged upstream
   - 40_add_libGLU.patch:
       libGLU not needed for arb_ntree)
   - 60_use_debian_packaged_raxml.patch:
       merged upstream
   - 70_hardening.patch
       merged upstream
   - 72_add_math_lib_to_linker.patch
       does not appear to be needed
* patches added:
   - 10_upstream_r12793__show_db_load_progress:
       backported patch showing progress while ARB is loading a database
       (needed as indicator/splash screen while ARB is launching)
   - 20_upstream_r12794__socket_permissions:
       backported security fix
   - 30_upstream_r12814__desktop_keywords:
       backported add keywords to desktop (fixes lintian warning)
   - 40_upstream_r12815__lintian_spelling:
       backported fix for lintian reported spelling errors
   - 50_private_nameservers
       change configuration to put nameservers into users home dirs
       (avoids need for shared writeable directory)
   - 60_use_debian_phyml
       use phyml from debian package for both interfaces in ARB
* debian/rules:
   - create config.makefile from override_dh_configure target
   - use "make tarfile" in override_dh_install
   - remove extra cleaning not needed for ARB 6
   - use "dh_install --list-missing" to avoid missing files
   - added override_dh_fixperms target
* debian/control:
   - added libarb-dev package
   - Depends: added phyml, xdg-utils
   - Suggests: removed phyml
   - fix lintian duplicate-short-description (new descriptions)
* debian/*.install:
   - "unrolled" confusing globbing to select files
   - pick files from debian/tmp
   - moved all config files to /etc/arb
* debian/arb-common.templates: updated
* scripts:
   - removed arb-add-pt-server
   - launch-wrapper: 
     - only add demo.arb to newly created $ARBUSERDATA
     - pass commandline arguments through bin/arb wrapper
   - preinst: removing old PT server index files on upgrade from 5.5*
   - postinst: set setgid on shared PT dir
* rewrote arb.1 manfile
* added file icon for ARB databases
* using upstream arb_tcp.dat

Show diffs side-by-side

added added

removed removed

Lines of Context:
HELP_SOURCE/oldhelp/next_neighbours_common.hlp
10
10
 
11
11
# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
12
12
 
13
 
#************* Title of helpfile !! and start of real helpfile @@@ ********
 
13
#************* Title of helpfile !! and start of real helpfile ********
14
14
TITLE           Nearest relative search
15
15
 
16
16
OCCURRENCE      ARB_NT/Search/More search/Search Next Relatives of SELECTED Species in PT Server
17
17
                ARB_NT/Search/More search/Search Next Relatives of LISTED Species in PT Server
18
 
                ARB_NT/ARB_EDIT/EDIT/Integrated Aligners
 
18
                ARB_EDIT4/Edit/Integrated Aligners
19
19
 
20
20
SECTION         ALGORITHM
21
21
 
50
50
                       faster than the 'Complete mode'. For some sequence types it completely fails,
51
51
                       e.g. if there are repetitive areas containing many 'AAAAA'
52
52
 
 
53
                       Relative and absolute scores will be approx. 1/4 (compared with complete mode) 
 
54
 
53
55
                Match score:
54
56
 
55
57
                       absolute:        returns the absolute number of hits
56
 
                       relative:        returns the number of hits relative to maximum possible hits
57
 
 
58
 
                       The score depends on several other parameters like number of allowed mismatches,
59
 
                       search mode, oligo length and complement settings.
60
 
 
61
 
                       The maximum absolute score is
62
 
 
63
 
                           (length of relatives sequence) minus (oligo length)
64
 
 
65
 
                       Practically this score is rarely reached, because several possible oligos are
66
 
                       skipped, namely
67
 
 
68
 
                                - all oligos starting with 2 identical nucleotides
69
 
                                - all oligos containing IUPAC codes (or N's)
70
 
 
71
 
                       If mismatches are used, each oligo may hit at several positions. Thus the
72
 
                       maximum relative score may exceed 100% (and the maximum absolute score may
73
 
                       exceed its theoretical maximum).
74
 
 
75
 
                       If you use 'Quick mode' the mean relative score will be approx. 25% (assuming
76
 
                       that 25% of the possible oligos start with an 'A').
77
 
 
78
 
                       That means.. only if you use
79
 
 
80
 
                            - 0 mismatches,
81
 
                            - 'Complete mode' and
82
 
                            - your sequences contain no IUPACs and no repetitions,
83
 
 
84
 
                       you will get a score of 100% (or sequenceLength-oligoLength) for
85
 
                       the selected species itself and its duplicates.
 
58
                       relative:        returns the number of hits relative to some maximum (see score-scaling)
 
59
 
 
60
                       Absolute hits:
 
61
 
 
62
                                Absolute hits are the number of oligos which occur in the source sequence
 
63
                                and in the targeted sequences (i.e. in the relatives of the source sequence).
 
64
 
 
65
                                If an oligo occurs multiple times in source or target sequence, it only
 
66
                                creates the minimum number of hits (e.g. if it occurs twice in source and
 
67
                                three times in a target, only two hits will be counted for that target).
 
68
 
 
69
                                The theoretical maximum for absolute hits is
 
70
 
 
71
                                    maxhits = minimumBasecount(source, target) - oligolen + 1
 
72
 
 
73
                                In practice that value is rarely or never reached because several oligos
 
74
                                are skipped, namely all oligos containing IUPAC codes, N's or dots.
 
75
                                The PT-server as well will not report matches hitting ambiguous positions
 
76
                                or sequence endings.
 
77
 
 
78
                                The number of absolute hits is as well affected by other parameters:
 
79
 
 
80
                                - using quick search will only produces around 25% of the hits as using
 
81
                                  complete search (assuming that 25% of all oligo starts with an 'A')
 
82
                                - searching for complement or reverse will duplicate the number of possible
 
83
                                  hits. Searching for all 4 reverse/complement-combinations will produce
 
84
                                  4 times as many hits as a plain forward search.
 
85
 
 
86
                       Relative score:
 
87
 
 
88
                                The relative score is absolute hits scaled versus a maximum POC (possible oligo count).
 
89
                                You can specify which maximum POC to use with the selection button next to
 
90
                                the score selection button:
 
91
 
 
92
                                        to source POC         maximum possible oligos in source
 
93
                                        to target POC         maximum possible oligos in target
 
94
                                        to minimum POC        minimum possible oligos in source or target
 
95
                                        to maximum POC        maximum possible oligos in source or target
 
96
 
 
97
                                'to source POC' will report ~100% score for partial source versus
 
98
                                all full sequences containing the part.
 
99
 
 
100
                                'to target POC' will report ~100% score for all partial target sequences
 
101
                                which are contained in the source sequence.
 
102
 
 
103
                                'to minimum POC' will report ~100% score if source is part of target or vice versa
 
104
                                (this was the default method in previous ARB versions). 
 
105
 
 
106
                                'to maximum POC' will report ~100% score if source and target contain each other, i.e.
 
107
                                if they have an identical oligo distribution. If either source or target is missing
 
108
                                some bases, the score will lower.
 
109
 
 
110
 
 
111
                                When using 'quick search mode' the max. relative score will be 25% (if 25% of
 
112
                                the oligos start with 'A').
 
113
 
 
114
                                When searching for forward and reverse-complement, the theoretical max. relative
 
115
                                score will be 200%. In practice it won't find much hits on the reverse-complement
 
116
                                strand. So you'll get similar scores as without reverse-complement, but especially
 
117
                                if you lower the oligo size, you'll probably reach scores above 100%.
 
118
 
 
119
 
 
120
                                The EDIT4 aligner currently always uses 'to minimum POC'. 
 
121
 
86
122
 
87
123
                Complement:
88
124
 
90
126
                       reverse:             Match only reverse oligos
91
127
                       complement:          Match only complement oligos
92
128
                       reverse-complement:  Match only reverse-complement oligos
93
 
                       and all combinations of these.
94
 
 
95
 
                       The combinations may affect the score as well!
 
129
 
 
130
                       The remaining options are combinations of the above.
 
131
 
 
132
                       The combinations will affect the score, especially for shorter oligos.
 
133
                       Please read the section about 'Relative score' above to avoid confusion.
96
134
 
97
135
                       Note: Not available for EDIT4 aligner.
98
136
 
99
 
NOTES           None
 
137
                Target range:
 
138
 
 
139
                       Restrict the alignment range in which oligos may match.
 
140
                       Hits outside that range will not be considered.
 
141
 
 
142
NOTES           Special effort is taken to eliminate multi-matches, which were ignored in past versions.
 
143
                That resulted in relative scores far beyond 100%, especially for small oligo-lengths.
 
144
 
 
145
                Now e.g. an oligo occurring 3 times in the source sequence will give atmost 3 absolute
 
146
                hitpoints to any target sequence - even if it occurs there far more often.
100
147
 
101
148
EXAMPLES        None
102
149
 
103
 
WARNINGS        None
 
150
WARNINGS        Use mismatches with care!
104
151
 
 
152
BUGS            Relative score is not scaled to the maximum possible hits in the target range.