source: trunk/HELP_SOURCE/source/primer_new.hlp

Last change on this file was 19532, checked in by westram, 6 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.5 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6SUB     iupac-codes.hlp
7
8# format described in ../help.readme
9
10
11TITLE           Design Primers
12
13OCCURRENCE      ARB_NT/Probes/Design Primers
14
15DESCRIPTION     Searches for primer pairs
16                within the given physical and biological ranges
17
18                       1. select a species (ARB_NT <INFO button>)
19                       2. open 'PRIMER DESIGN' window
20                       3. specify search parameters
21                       4. press 'GO' (will open LINK{primer_result.hlp}).
22
23                INIT FROM SPECIES/GENE
24
25                     This initializes the values left and right position and
26                     the primer distance with (hopefully) reasonable defaults.
27
28SECTION         Search parameters
29
30                  Left/right position
31
32                    specifies the ranges (where the primer shall reside) using
33                    a START position and a given NUMBER OF BASES.
34
35                    The actual sequence data of the currently selected species
36                    is examined and the end position of the primer range is
37                    set dynamically, such that the range contains the specified
38                    number of bases.
39
40                  Primer length
41
42                    Specifies a lower and upper limit for the number of bases the
43                    reported primers shall contain.
44
45                  Primer distance
46
47                    Specifies the minimum and maximum wanted
48                    distance (in number of bases) between the
49                    left and right primer of the reported primer pairs.
50                    Optional parameters (ignored if 0).
51
52                  G+C ratio / temperature
53
54                    Specifies minima and maxima for G+C-ratio and temperature of
55                    the reported primers.
56
57                  Min. dist to next match of primer
58
59                    If a value above zero is specified, the search accepts
60                    primers matching at additional positions, if the distance
61                    betweeen the selected position and additional positions is
62                    greater than the specified value.
63
64                    A value of zero or below forces all primers to be well-defined (i.e.
65                    to match only once).
66
67                    Example: primerposition   100
68                             min.dist          50
69                             2nd occurrence    30 => distance 70 => primer remains in list
70                             3rd occurrence   140 => distance 40 => primer is removed from list
71
72                  Expand IUPAC codes
73
74                    If option is checked, all possibilities of IUPAC codes are permutated
75                    when testing for primer matches.
76
77                    When unchecked, primers containing IUPAC codes will not be considered.
78
79                  Max. number of results
80
81                    Limits the number of reported results.
82
83                  G+C- / temperature-factor
84
85                    Allows to weight the impact of G+C vs. temperature while scoring
86                    the reported results.
87
88
89
90NOTES           all specified positions are from range [0 .. N-1], i.e. when you use a position
91                from EDIT4, you need to subtract 1
92
93SECTION         WRITTEN BY
94
95                Wolfram Foerster 2001
96
97EXAMPLES        None
98
99WARNINGS        ARB will crash if you use Primer Design without taking care
100                about the estimated memory needed (lower right corner).
101
102BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.