source: branches/help/HELP_SOURCE/source/arb_db.hlp

Last change on this file was 18796, checked in by westram, 3 years ago
  • minor fixes to help content:
    • change order of MAIN TOPICS.
    • fix unicode quotes.
    • link to 'Save database'.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.9 KB
Line 
1#Please insert up references in the next lines (line starts with keyword UP)
2UP      arb.hlp
3UP      glossary.hlp
4
5#Please insert subtopic references  (line starts with keyword SUB)
6#SUB    subtopic.hlp
7
8# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
9
10#************* Title of helpfile !! and start of real helpfile ********
11TITLE           ARB: Database
12
13OCCURRENCE      ARB_NT
14
15DESCRIPTION
16                A central database of sequences and
17                additional information (taken from public databases or supplied
18                by the user) is stored in a binary or ASCII file (*.arb).
19                ( and in future releases archive and delta files).
20                The database reader auto-detects binary or ASCII mode.
21                Brief advantages of the different file types:
22
23                binary with fast load file:
24
25                                (+)  very fast
26                                (+)  runs on slow and old computers
27                                (-)  needs a lot of harddisc space
28                                => for normal operation on old machines
29
30                binary:
31
32                (+)  very fast
33                                (+)  small (compression rate: 60%-95%)
34                                => for normal operation
35
36                ASCII:
37
38                (+)  editable by standard text editors
39                                (+)  information can be extracted by hand
40                                (-)  needs an extreme amount of harddisc space
41                                => to check and correct a database
42
43
44                All ARB tools for database handling and most of the ARB tools
45                for data analysis act directly upon the database. The database
46                is kept consistent at any time. Any local modifications by
47                individual ARB tools are immediately exported to the database
48                and all other active tools.
49
50        The database is stored in-memory only until you
51        LINK{save.hlp}.
52
53NOTES ASCII format
54
55    DATA FORMAT
56
57             [xxx]      means xxx is optional
58             [xxx]*     means xxx is optional and can occur many times
59             xxx|yyy    means xxx or yyy
60             //         means comment
61
62    ARBDB HIERARCHY
63
64        ARB DB is a hierarchical database system, so here's a short description
65        of the hierarchy:
66
67        ARBDB ::=       species_data            // container containing all species
68                        presets                 // global alignment and db field information
69                        [extended_data]         // all SAIs
70                        [tmp]                   // temporary data
71                        [tree_data]             // all trees
72                        ...                     // user defined entries (programmers)
73
74        species_data::=   [species]*
75
76        extended_data::=  [extended]*
77
78        gene_data::=      [gene]*               // container for genes (species local)
79
80
81        species::=      'name'                  // species identifier
82                        ['full_name']
83                        ...                     // (end) user defined fields
84                        [ali_xxx]               // the alignment container(s)
85                        [gene_data]             // container containing genes
86
87        extended::=                             // analogous to species
88
89        gene::=                                 // analogous to species
90
91        ali_xxx::=      'data'                  // the sequence
92                        ...                     // additional sequence information
93
94        presets::=      'use'                   // default alignment
95                        [alignment]*
96                        [key_data]              // description of the user defined keys
97
98        alignment::=    'alignment_name'        // name of the alignment (prefix 'ali_')
99                        'alignment_len'         // length of longest sequence
100                        'alignment_write_security' // default write security
101                        'alignment_type'        // dna or pro
102                        'aligned'               // ==1 when all sequences have the same
103                                                // length else 0
104        key_data::=     [key]*
105
106        key::=          'key_name'              // name of an user defined field
107                        'key_type'              // type (12=string 3=int)
108
109        *******************************************
110        *************** ASCII  BASIC **************
111        *******************************************
112
113        Note:
114
115                                - /* xxx */ is used for comments and not read
116
117                                - I use a grammar to describe the dataformat.
118                                  All terminal symbols are surrounded by "'".
119
120        ASCII::=        ['/*ARBDB ASCII*/']
121                        [FIELD]*
122
123        FIELD::=        KEY [PROTECTION] [TYPE] VALUE
124                        |
125                        KEY [PROTECTION] '%%' (%
126                                [FIELD]*
127                                %) /* Comment */
128
129
130        KEY::=          'Any string of a-z|A-Z|0-9|"_"'
131                        |KEY| > 2  < 256
132
133        PROTECTION::=   ':''delete protection level''write p.l.''00'
134                                        // 00 are reserved for future use
135
136        TYPE::=         '%s'            // STRING
137                        '%i'            // INTEGER
138                        '%f'            // FLOAT
139                        '%N'            // BYTES
140                        '%I'            // BITS
141                        '%F'            // FLOATS
142
143
144        VALUE::=        '"string"' | '"^Astring^A"' | 'string'  //type = STRING
145                        | 'int_number'                          //type = INT
146                        | 'real_number'                         //type = FLOAT
147                        | 'coded bytestring'                    //type = BYTES,FLOATS,
148                                                                //      BITS
149
150
151EXAMPLES        None
152
153        *******************************************
154        ************** ASCII  EXAMPLE *************
155        *******************************************
156
157        /*ARBDB ASCII*/
158        species_data    %% (%
159                species :5000   %% (%
160                        name    :7600           "EscCol10"
161                        file            "ecrna3.empro"
162                        full_name               "Escherichia coli"
163                        acc             "V00331;"
164                        ali_23all       :5000   %% (%
165                                data    :7500           "...........ACGTUUU...........
166                                mark    %I              "---------------++++---------
167                                %) /*ali_23all*/
168
169                species :5000   %% (%
170                        name    :7600           "EscCol11"
171                        file            "ecrr23s.empro"
172                        full_name               "Escherichia coli"
173                        ali_23all       :5000   %% (%
174                                data    :7500           "...........ACGTUUUGGG.......
175                                mark    %I              "---------------++++---------
176                                %) /*ali_23all*/
177                        %) /*species*/
178                %) /*species_data*/
179        presets %% (%
180                use             "ali_23all"
181                max_alignment_len       %i 2000
182                alignment_len   %i 0
183                max_name_len    %i 9
184                alignment       %% (%
185                        alignment_name          "ali_23all"
186                        alignment_len   %i 4205
187                        aligned %i 1
188                        alignment_write_security        %i 5
189                        alignment_type          "rna"
190                        %) /*alignment*/
191                key_data        %% (%
192                        key     %% (%
193                                key_name                "name"
194                                key_type        %i 12
195                                %) /*key*/
196                        key     %% (%
197                                key_name                "group_name"
198                                key_type        %i 12
199                                %) /*key*/
200                        key     %% (%
201                                key_name                "acc"
202                                key_type        %i 12
203                                %) /*key*/
204                        key     %% (%
205                                key_name                "ali_23all/data"
206                                key_type        %i 12
207                                %) /*key*/
208                        key     %% (%
209                                key_name                "ali_23all/mark"
210                                key_type        %i 6
211                                %) /*key*/
212                        key     %% (%
213                                key_name                "aligned"
214                                key_type        %i 12
215                                %) /*key*/
216                        key     %% (%
217                                key_name                "author"
218                                key_type        %i 12
219                                %) /*key*/
220                        %) /*key_data*/
221                %) /*presets*/
222        tree_data       %% (%
223                tree_main       :4400   %% (%
224                        nnodes  %i 2
225                        tree            "N0.014808,0.015168;N0.000360,0.000360;LEscCol10^ALEscColi^ALEscCol11^A"
226                        ruler   %% (%
227                                size    %f 0.100000
228                                RADIAL  %% (%
229                                        ruler_y %f 0.341577
230                                        ruler_x %f 0.000000
231                                        %) /*RADIAL*/
232                                text_x  %f 0.000000
233                                text_y  %f 0.000000
234                                ruler_width     %i 0
235                                LIST    %% (%
236                                        ruler_y %f 0.000000
237                                        ruler_x %f 0.000000
238                                        %) /*LIST*/
239                                %) /*ruler*/
240                        %) /*tree_main*/
241                %) /*tree_data*/
242        extended_data   :7000   %% (%
243                extended        %% (%
244                        name            "HELIX_PAIRS"
245                        ali_23all       %% (%
246                                data            "............................1a..
247                                %) /*ali_23all*/
248                        %) /*extended*/
249                extended        %% (%
250                        name            "gpl5rr"
251                        ali_23all       %% (%
252                                phyl_options    %N      10000106D02:0C03.0D02-07.87.DB6
253                                bits    %I      "-----------------------+++++++++-+-+++
254                                floats  %F      10000106D04:0A.C816.425C03.5D.802F.BF03
255                                %) /*ali_23all*/
256                        %) /*extended*/
257                %) /*extended_data*/
258        tmp     %% (%
259                focus   %% (%
260                        species_name            "EscColi"
261                        cursor_position %i 323
262                        %) /*focus*/
263                message         ""
264                %) /*tmp*/
265
266
267WARNINGS        The ASCII version of arb needs a lot of virtual memory when
268                loaded.
269
Note: See TracBrowser for help on using the repository browser.