[Bio] / Sprout / SproutDBD.xml Repository:
ViewVC logotype

Annotation of /Sprout/SproutDBD.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.30 - (view) (download) (as text)

1 : parrello 1.1 <?xml version="1.0" encoding="utf-8" ?>
2 :     <Database>
3 :     <Title>Sprout Genome and Subsystem Database</Title>
4 :     <Entities>
5 :     <Entity name="Genome" keyType="name-string">
6 :     <Notes>A [i]genome[/i] contains the sequence data for a particular individual organism.</Notes>
7 :     <Fields>
8 :     <Field name="genus" type="name-string">
9 :     <Notes>Genus of the relevant organism.</Notes>
10 :     <DataGen pass="1">RandParam('streptococcus', 'staphyloccocus', 'felis', 'homo', 'ficticio', 'strangera', 'escherischia', 'carborunda')</DataGen>
11 :     </Field>
12 :     <Field name="species" type="name-string">
13 : parrello 1.8 <Notes>Species of the relevant organism.</Notes>
14 : parrello 1.1 <DataGen pass="1">StringGen('PKVKVKVKVKV')</DataGen>
15 : parrello 1.8 </Field>
16 : parrello 1.1 <Field name="unique-characterization" type="medium-string">
17 : parrello 1.8 <Notes>The unique characterization identifies the particular organism instance from which the
18 :     genome is taken. It is possible to have in the database more than one genome for a
19 : parrello 1.1 particular species, and every individual organism has variations in its DNA.</Notes>
20 : parrello 1.8 <DataGen>StringGen('PKVKVK999')</DataGen>
21 : parrello 1.1 </Field>
22 :     <Field name="access-code" type="key-string">
23 : parrello 1.8 <Notes>The access code determines which users can look at the data relating to this genome.
24 :     Each user is associated with a set of access codes. In order to view a genome, one of
25 :     the user's access codes must match this value.</Notes>
26 :     <DataGen>RandParam('low','medium','high')</DataGen>
27 :     </Field>
28 : parrello 1.15 <Field name="complete" type="boolean">
29 :     <Notes>TRUE if the genome is complete, else FALSE</Notes>
30 :     </Field>
31 : parrello 1.8 <Field name="taxonomy" type="text">
32 :     <Notes>The taxonomy string contains the full taxonomy of the organism, while individual elements
33 :     separated by semi-colons (and optional white space), starting with the domain and ending with
34 :     the disambiguated genus and species (which is the organism's scientific name plus an
35 :     identifying string).</Notes>
36 :     <DataGen pass="2">join('; ', (RandParam('bacteria', 'archaea', 'eukaryote', 'virus', 'environmental'),
37 :     ListGen('PKVKVKVK', 5), $this->{genus}, $this->{species}))</DataGen>
38 :     </Field>
39 :     <Field name="group-name" type="name-string" relation="GenomeGroups">
40 :     <Notes>The group identifies a special grouping of organisms that would be displayed on a particular
41 :     page or of particular interest to a research group or web site. A single genome can belong to multiple
42 :     such groups or none at all.</Notes>
43 :     </Field>
44 : parrello 1.1 </Fields>
45 :     <Indexes>
46 :     <Index>
47 :     <Notes>This index allows the applications to find all genomes associated with
48 :     a specific access code, so that a complete list of the genomes users can view
49 :     may be generated.</Notes>
50 :     <IndexFields>
51 :     <IndexField name="access-code" order="ascending" />
52 :     <IndexField name="genus" order="ascending" />
53 :     <IndexField name="species" order="ascending" />
54 :     <IndexField name="unique-characterization" order="ascending" />
55 :     </IndexFields>
56 :     </Index>
57 :     <Index Unique="false">
58 :     <Notes>This index allows the applications to find all genomes for a particular
59 :     species.</Notes>
60 :     <IndexFields>
61 :     <IndexField name="genus" order="ascending" />
62 :     <IndexField name="species" order="ascending" />
63 :     <IndexField name="unique-characterization" order="ascending" />
64 :     </IndexFields>
65 :     </Index>
66 :     </Indexes>
67 :     </Entity>
68 :     <Entity name="Source" keyType="medium-string">
69 :     <Notes>A [i]source[/i] describes a place from which genome data was taken. This can be an organization
70 :     or a paper citation.</Notes>
71 :     <Fields>
72 :     <Field name="URL" type="string" relation="SourceURL">
73 : parrello 1.8 <Notes>URL the paper cited or of the organization's web site. This field optional.</Notes>
74 :     <DataGen>"http://www.conservativecat.com/Ferdy/TestTarget.php?Source=" . $this->{id}</DataGen>
75 :     </Field>
76 : parrello 1.1 <Field name="description" type="text">
77 : parrello 1.8 <Notes>Description the source. The description can be a street address or a citation.</Notes>
78 :     <DataGen>$this->{id} . ': ' . StringGen(IntGen(50,200))</DataGen>
79 :     </Field>
80 : parrello 1.1 </Fields>
81 :     </Entity>
82 :     <Entity name="Contig" keyType="name-string">
83 :     <Notes>A [i]contig[/i] is a contiguous run of residues. The contig's ID consists of the
84 :     genome ID followed by a name that identifies which contig this is for the parent genome. As
85 :     is the case with all keys in this database, the individual components are separated by a
86 :     period.
87 :     [p]A contig can contain over a million residues. For performance reasons, therefore,
88 :     the contig is split into multiple pieces called [i]sequences[/i]. The sequences
89 :     contain the characters that represent the residues as well as data on the quality of
90 :     the residue identification.</Notes>
91 :     </Entity>
92 :     <Entity name="Sequence" keyType="name-string">
93 :     <Notes>A [i]sequence[/i] is a continuous piece of a [i]contig[/i]. Contigs are split into
94 :     sequences so that we don't have to have the entire contig in memory when we are
95 :     manipulating it. The key of the sequence is the contig ID followed by the index of
96 :     the begin point.</Notes>
97 :     <Fields>
98 :     <Field name="sequence" type="text">
99 : parrello 1.8 <Notes>String consisting of the residues. Each residue is described by a single
100 :     character in the string.</Notes>
101 :     <DataGen>RandChars("ACGT", IntGen(100,400))</DataGen>
102 :     </Field>
103 : parrello 1.1 <Field name="quality-vector" type="text">
104 : parrello 1.9 <Notes>String describing the quality data for each base pair. Individual values will
105 : parrello 1.8 be separated by periods. The value represents negative exponent of the probability
106 :     of error. Thus, for example, a quality of 30 indicates the probability of error is
107 :     10^-30. A higher quality number a better chance of a correct match. It is possible
108 : parrello 1.9 that the quality data is not known for a sequence. If that is the case, the quality
109 : parrello 1.8 vector will contain the [b]unknown[/b].</Notes>
110 :     <DataGen>unknown</DataGen>
111 :     </Field>
112 : parrello 1.1 </Fields>
113 :     </Entity>
114 : parrello 1.25 <Entity name="Feature" keyType="id-string">
115 : parrello 1.1 <Notes>A [i]feature[/i] is a part of a genome that is of special interest. Features
116 :     may be spread across multiple contigs of a genome, but never across more than
117 :     one genome. Features can be assigned to roles via spreadsheet cells,
118 :     and are the targets of annotation.</Notes>
119 :     <Fields>
120 :     <Field name="feature-type" type="string">
121 : parrello 1.8 <Notes>Code indicating the type of this feature.</Notes>
122 :     <DataGen>RandParam('peg','rna')</DataGen>
123 :     </Field>
124 : parrello 1.14 <Field name="alias" type="medium-string" relation="FeatureAlias">
125 : parrello 1.9 <Notes>Alternative name for this feature. A feature can have many aliases.</Notes>
126 : parrello 1.8 <DataGen testCount="3">StringGen('Pgi|99999', 'Puni|XXXXXX', 'PAAAAAA999')</DataGen>
127 :     </Field>
128 : parrello 1.1 <Field name="translation" type="text" relation="FeatureTranslation">
129 : parrello 1.8 <Notes>[i](optional)[/i] A translation of this feature's residues into character
130 :     codes, formed by concatenating the pieces of the feature together. For a
131 :     protein encoding group, this is the protein characters. For other types
132 :     it is the DNA characters.</Notes>
133 :     <DataGen testCount="0"></DataGen>
134 :     </Field>
135 : parrello 1.1 <Field name="upstream-sequence" type="text" relation="FeatureUpstream">
136 : parrello 1.8 <Notes>Upstream sequence the feature. This includes residues preceding the feature as well as some of
137 :     the feature's initial residues.</Notes>
138 :     <DataGen testCount="0"></DataGen>
139 :     </Field>
140 : parrello 1.1 <Field name="active" type="boolean">
141 : parrello 1.11 <Notes>TRUE if this feature is still considered valid, FALSE if it has been logically deleted.</Notes>
142 : parrello 1.8 <DataGen>1</DataGen>
143 :     </Field>
144 :     <Field name="link" type="text" relation="FeatureLink">
145 :     <Notes>Web hyperlink for this feature. A feature have no hyperlinks or it can have many. The
146 :     links are to other websites that have useful about the gene that the feature represents, and
147 :     are coded as raw HTML, using [b]&lt;a href="[i]link[/i]"&gt;[i]text[/i]&lt;/a&gt;[/b] notation.</Notes>
148 :     <DataGen testCount="3">'http://www.conservativecat.com/Ferdy/TestTarget.php?Source=' . $this->{id} .
149 :     "&amp;Number=" . IntGen(1,99)</DataGen>
150 :     </Field>
151 : parrello 1.1 </Fields>
152 : parrello 1.8 <Indexes>
153 :     <Index>
154 :     <Notes>This index allows the user to find the feature corresponding to
155 :     the specified alias name.</Notes>
156 :     <IndexFields>
157 :     <IndexField name="alias" order="ascending" />
158 :     </IndexFields>
159 :     </Index>
160 :     </Indexes>
161 : parrello 1.1 </Entity>
162 : parrello 1.27 <Entity name="SynonymGroup" keyType="id-string">
163 :     <Notes>A [i]synonym group[/i] represents a group of features. Substantially identical features
164 :     are mapped to the same synonym group, and this information is used to expand similarities.</Notes>
165 :     </Entity>
166 : parrello 1.1 <Entity name="Role" keyType="string">
167 :     <Notes>A [i]role[/i] describes a biological function that may be fulfilled by a feature.
168 :     One of the main goals of the database is to record the roles of the various features.</Notes>
169 : parrello 1.8 <Fields>
170 : parrello 1.18 <Field name="EC" type="string" relation="RoleEC">
171 :     <Notes>EC code for this role.</Notes>
172 : parrello 1.8 <DataGen testCount="1">StringGen(IntGen(20,40)) . "(" . $this->{id} . ")"</DataGen>
173 :     </Field>
174 : parrello 1.15 <Field name="abbr" type="name-string">
175 :     <Notes>Abbreviated name for the role, generally non-unique, but useful
176 :     in column headings for HTML tables.</Notes>
177 :     </Field>
178 : parrello 1.8 </Fields>
179 : parrello 1.18 <Indexes>
180 :     <Index>
181 :     <Notes>This index allows the user to find the role corresponding to
182 :     an EC number.</Notes>
183 :     <IndexFields>
184 :     <IndexField name="EC" order="ascending" />
185 :     </IndexFields>
186 :     </Index>
187 :     </Indexes>
188 : parrello 1.1 </Entity>
189 :     <Entity name="Annotation" keyType="name-string">
190 :     <Notes>An [i]annotation[/i] contains supplementary information about a feature. Annotations
191 : parrello 1.8 are currently the only objects that may be inserted directly into the database. All other
192 : parrello 1.24 information is loaded from data exported by the SEED.</Notes>
193 : parrello 1.8 <Fields>
194 :     <Field name="time" type="date">
195 :     <Notes>Date and time of the annotation.</Notes>
196 :     </Field>
197 :     <Field name="annotation" type="text">
198 :     <Notes>Text of the annotation.</Notes>
199 :     </Field>
200 : parrello 1.1 </Fields>
201 : parrello 1.26 <Indexes>
202 :     <Index>
203 :     <Notes>This index allows the user to find recent annotations.</Notes>
204 :     <IndexFields>
205 :     <IndexField name="time" order="descending" />
206 :     </IndexFields>
207 :     </Index>
208 :     </Indexes>
209 : parrello 1.1 </Entity>
210 : parrello 1.15 <Entity name="Reaction" keyType="key-string">
211 :     <Notes>A [i]reaction[/i] is a chemical process catalyzed by a protein. The reaction ID
212 :     is generally a small number preceded by a letter.</Notes>
213 :     <Fields>
214 :     <Field name="url" type="string" relation="ReactionURL">
215 :     <Notes>HTML string containing a link to a web location that describes the
216 :     reaction. This field is optional.</Notes>
217 :     </Field>
218 :     <Field name="rev" type="boolean">
219 :     <Notes>TRUE if this reaction is reversible, else FALSE</Notes>
220 :     </Field>
221 :     </Fields>
222 :     </Entity>
223 :     <Entity name="Compound" keyType="name-string">
224 :     <Notes>A [i]compound[/i] is a chemical that participates in a reaction.
225 :     All compounds have a unique ID and may also have one or more names.</Notes>
226 :     <Fields>
227 :     <Field name="name-priority" type="int" relation="CompoundName">
228 :     <Notes>Priority of a compound name. The name with the loweset
229 :     priority is the main name of this compound.</Notes>
230 :     </Field>
231 :     <Field name="name" type="name-string" relation="CompoundName">
232 :     <Notes>Descriptive name for the compound. A compound may
233 :     have several names.</Notes>
234 :     </Field>
235 :     <Field name="cas-id" type="name-string" relation="CompoundCAS">
236 :     <Notes>Chemical Abstract Service ID for this compound (optional).</Notes>
237 :     </Field>
238 : parrello 1.19 <Field name="label" type="name-string">
239 :     <Notes>Name used in reaction display strings.
240 :     It is the same as the name possessing a priority of 1, but it is placed
241 :     here to speed up the query used to create the display strings.</Notes>
242 :     </Field>
243 : parrello 1.15 </Fields>
244 :     <Indexes>
245 :     <Index>
246 :     <Notes>This index allows the user to find the compound corresponding to
247 :     the specified name.</Notes>
248 :     <IndexFields>
249 :     <IndexField name="name" order="ascending" />
250 :     </IndexFields>
251 :     </Index>
252 :     <Index>
253 : parrello 1.17 <Notes>This index allows the user to find the compound corresponding to
254 :     the specified CAS ID.</Notes>
255 :     <IndexFields>
256 :     <IndexField name="cas-id" order="ascending" />
257 :     </IndexFields>
258 :     </Index>
259 :     <Index>
260 : parrello 1.15 <Notes>This index allows the user to access the compound names in
261 :     priority order.</Notes>
262 :     <IndexFields>
263 :     <IndexField name="id" order="ascending" />
264 :     <IndexField name="name-priority" order="ascending" />
265 :     </IndexFields>
266 :     </Index>
267 :     </Indexes>
268 :     </Entity>
269 : parrello 1.5 <Entity name="Subsystem" keyType="string">
270 : parrello 1.1 <Notes>A [i]subsystem[/i] is a collection of roles that work together in a cell. Identification of subsystems
271 :     is an important tool for recognizing parallel genetic features in different organisms.</Notes>
272 : parrello 1.15 <Fields>
273 :     <Field name="curator" type="string">
274 :     <Notes>Name of the person currently in charge of the subsystem.</Notes>
275 :     </Field>
276 :     <Field name="notes" type="text">
277 :     <Notes>Descriptive notes about the subsystem.</Notes>
278 :     </Field>
279 : parrello 1.28 <Field name="classification" type="string" relation="SubsystemClass">
280 :     <Notes>General classification data about the subsystem.</Notes>
281 :     </Field>
282 : parrello 1.15 </Fields>
283 :     </Entity>
284 :     <Entity name="RoleSubset" keyType="string">
285 :     <Notes>A [i]role subset[/i] is a named collection of roles in a particular subsystem. The
286 :     subset names are generally very short, non-unique strings. The ID of the parent
287 :     subsystem is prefixed to the subset ID in order to make it unique.</Notes>
288 :     </Entity>
289 :     <Entity name="GenomeSubset" keyType="string">
290 :     <Notes>A [i]genome subset[/i] is a named collection of genomes that participate
291 :     in a particular subsystem. The subset names are generally very short, non-unique
292 :     strings. The ID of the parent subsystem is prefixed to the subset ID in order
293 :     to make it unique.</Notes>
294 : parrello 1.1 </Entity>
295 : parrello 1.24 <Entity name="SSCell" keyType="hash-string">
296 : parrello 1.1 <Notes>Part of the process of locating and assigning features is creating a spreadsheet of
297 :     genomes and roles to which features are assigned. A [i]spreadsheet cell[/i] represents one
298 :     of the positions on the spreadsheet.</Notes>
299 :     </Entity>
300 :     <Entity name="SproutUser" keyType="name-string">
301 :     <Notes>A [i]user[/i] is a person who can make annotations and view data in the database. The
302 :     user object is keyed on the user's login name.</Notes>
303 :     <Fields>
304 : parrello 1.8 <Field name="description" type="string">
305 :     <Notes>Full name or description of this user.</Notes>
306 :     </Field>
307 : parrello 1.1 <Field name="access-code" type="key-string" relation="UserAccess">
308 : parrello 1.8 <Notes>Access code possessed by this
309 : parrello 1.1 user. A user can have many access codes; a genome is accessible to the user if its
310 :     access code matches any one of the user's access codes.</Notes>
311 : parrello 1.8 <DataGen testCount="2">RandParam('low', 'medium', 'high')</DataGen>
312 :     </Field>
313 : parrello 1.1 </Fields>
314 :     </Entity>
315 : parrello 1.8 <Entity name="Property" keyType="int">
316 :     <Notes>A [i]property[/i] is a type of assertion that could be made about the properties of
317 :     a particular feature. Each property instance is a key/value pair and can be associated
318 :     with many different features. Conversely, a feature can be associated with many key/value
319 :     pairs, even some that notionally contradict each other. For example, there can be evidence
320 :     that a feature is essential to the organism's survival and evidence that it is superfluous.</Notes>
321 :     <Fields>
322 :     <Field name="property-name" type="name-string">
323 :     <Notes>Name of this property.</Notes>
324 :     </Field>
325 :     <Field name="property-value" type="string">
326 :     <Notes>Value associated with this property. For each property
327 :     name, there must by a property record for all of its possible
328 :     values.</Notes>
329 :     </Field>
330 :     </Fields>
331 :     <Indexes>
332 :     <Index>
333 :     <Notes>This index enables the application to find all values for a specified property
334 :     name, or any given name/value pair.</Notes>
335 :     <IndexFields>
336 :     <IndexField name="property-name" order="ascending" />
337 :     <IndexField name="property-value" order="ascending" />
338 :     </IndexFields>
339 :     </Index>
340 :     </Indexes>
341 :     </Entity>
342 :     <Entity name="Diagram" keyType="name-string">
343 :     <Notes>A functional diagram describes the chemical reactions, often comprising a single
344 :     subsystem. A diagram is identified by a short name and contains a longer descriptive name.
345 :     The actual diagram shows which functional roles guide the reactions along with the inputs
346 :     and outputs; the database, however, only indicate which roles belong to a particular
347 :     map.</Notes>
348 :     <Fields>
349 :     <Field name="name" type="text">
350 :     <Notes>Descriptive name of this diagram.</Notes>
351 :     </Field>
352 :     </Fields>
353 :     </Entity>
354 :     <Entity name="ExternalAliasOrg" keyType="name-string">
355 :     <Notes>An external alias is a feature name for a functional assignment that is not a
356 :     FIG ID. Functional assignments for external aliases are kept in a separate section of
357 :     the database. This table contains a description of the relevant organism for an
358 :     external alias functional assignment.</Notes>
359 :     <Fields>
360 :     <Field name="org" type="text">
361 :     <Notes>Descriptive name of the target organism for this external alias.</Notes>
362 :     </Field>
363 :     </Fields>
364 :     </Entity>
365 :     <Entity name="ExternalAliasFunc" keyType="name-string">
366 :     <Notes>An external alias is a feature name for a functional assignment that is not a
367 :     FIG ID. Functional assignments for external aliases are kept in a separate section of
368 :     the database. This table contains the functional role for the external alias functional
369 :     assignment.</Notes>
370 :     <Fields>
371 :     <Field name="func" type="text">
372 :     <Notes>Functional role for this external alias.</Notes>
373 :     </Field>
374 :     </Fields>
375 :     </Entity>
376 : parrello 1.29 <Entity name="Coupling" keyType="id-string">
377 : parrello 1.6 <Notes>A coupling is a relationship between two features. The features are
378 :     physically close on the contig, and there is evidence that they generally
379 :     belong together. The key of this entity is formed by combining the coupled
380 : parrello 1.8 feature IDs with a space.</Notes>
381 : parrello 1.6 <Fields>
382 :     <Field name="score" type="int">
383 :     <Notes>A number based on the set of PCHs (pairs of close homologs). A PCH
384 :     indicates that two genes near each other on one genome are very similar to
385 :     genes near each other on another genome. The score only counts PCHs for which
386 :     the genomes are very different. (In other words, we have a pairing that persists
387 :     between different organisms.) A higher score implies a stronger meaning to the
388 :     clustering.</Notes>
389 :     </Field>
390 :     </Fields>
391 :     </Entity>
392 : parrello 1.30 <Entity name="PCH" keyType="counter">
393 : parrello 1.6 <Notes>A PCH (physically close homolog) connects a clustering (which is a
394 :     pair of physically close features on a contig) to a second pair of physically
395 :     close features that are similar to the first. Essentially, the PCH is a
396 :     relationship between two clusterings in which the first clustering's features
397 :     are similar to the second clustering's features. The simplest model for
398 :     this would be to simply relate clusterings to each other; however, not all
399 :     physically close pairs qualify as clusterings, so we relate a clustering to
400 : parrello 1.30 a pair of features. The key a unique ID number.</Notes>
401 : parrello 1.6 <Fields>
402 :     <Field name="used" type="boolean">
403 :     <Notes>TRUE if this PCH is used in scoring the attached clustering,
404 :     else FALSE. If a clustering has a PCH for a particular genome and many
405 :     similar genomes are present, then a PCH will probably exist for the
406 :     similar genomes as well. When this happens, only one of the PCHs will
407 :     be scored: the others are considered duplicates of the same evidence.</Notes>
408 :     </Field>
409 :     </Fields>
410 :     </Entity>
411 : parrello 1.1 </Entities>
412 :     <Relationships>
413 : parrello 1.6 <Relationship name="ParticipatesInCoupling" from="Feature" to="Coupling" arity="MM">
414 :     <Notes>This relationship connects a feature to all the functional couplings
415 :     in which it participates. A functional coupling is a recognition of the fact
416 :     that the features are close to each other on a chromosome, and similar
417 :     features in other genomes also tend to be close.</Notes>
418 :     <Fields>
419 :     <Field name="pos" type="int">
420 :     <Notes>Ordinal position of the feature in the coupling. Currently,
421 :     this is either "1" or "2".</Notes>
422 :     </Field>
423 :     </Fields>
424 :     <ToIndex>
425 :     <Notes>This index enables the application to view the features of
426 :     a coupling in the proper order. The order influences the way the
427 :     PCHs are examined.</Notes>
428 :     <IndexFields>
429 :     <IndexField name="pos" order="ascending" />
430 :     </IndexFields>
431 :     </ToIndex>
432 :     </Relationship>
433 : parrello 1.27 <Relationship name="IsSynonymGroupFor" from="SynonymGroup" to="Feature" arity="1M">
434 :     <Notes>This relation connects a synonym group to the features that make it
435 :     up.</Notes>
436 :     </Relationship>
437 : parrello 1.24 <Relationship name="HasFeature" from="Genome" to="Feature" arity="1M">
438 :     <Notes>This relationship connects a genome to all of its features. This
439 :     relationship is redundant in a sense, because the genome ID is part
440 :     of the feature ID; however, it makes the creation of certain queries more
441 :     convenient because you can drag in filtering information for a feature's
442 :     genome.</Notes>
443 :     <Fields>
444 :     <Field name="type" type="key-string">
445 :     <Notes>Feature type (eg. peg, rna)</Notes>
446 :     </Field>
447 :     </Fields>
448 :     <ToIndex>
449 :     <Notes>This index enables the application to view the features of a
450 :     Genome sorted by type.</Notes>
451 :     <IndexFields>
452 :     <IndexField name="type" order="ascending" />
453 :     </IndexFields>
454 :     </ToIndex>
455 :     </Relationship>
456 : parrello 1.6 <Relationship name="IsEvidencedBy" from="Coupling" to="PCH" arity="1M">
457 :     <Notes>This relationship connects a functional coupling to the physically
458 :     close homologs (PCHs) which affirm that the coupling is meaningful.</Notes>
459 :     </Relationship>
460 :     <Relationship name="UsesAsEvidence" from="PCH" to="Feature" arity="MM">
461 :     <Notes>This relationship connects a PCH to the features that represent its
462 :     evidence. Each PCH is connected to a parent coupling that relates two features
463 :     on a specific genome. The PCH's evidence that the parent coupling is functional
464 :     is the existence of two physically close features on a different genome that
465 :     correspond to the features in the coupling. Those features are found on the
466 :     far side of this relationship.</Notes>
467 :     <Fields>
468 :     <Field name="pos" type="int">
469 :     <Notes>Ordinal position of the feature in the coupling that corresponds
470 :     to our target feature. There is a one-to-one correspondence between the
471 :     features connected to the PCH by this relationship and the features
472 :     connected to the PCH's parent coupling. The ordinal position is used
473 :     to decode that relationship. Currently, this field is either "1" or
474 :     "2".</Notes>
475 :     </Field>
476 :     </Fields>
477 :     <FromIndex>
478 :     <Notes>This index enables the application to view the features of
479 :     a PCH in the proper order.</Notes>
480 :     <IndexFields>
481 :     <IndexField name="pos" order="ascending" />
482 :     </IndexFields>
483 :     </FromIndex>
484 :     </Relationship>
485 : parrello 1.1 <Relationship name="HasContig" from="Genome" to="Contig" arity="1M">
486 :     <Notes>This relationship connects a genome to the contigs that contain the actual genetic
487 :     information.</Notes>
488 :     </Relationship>
489 :     <Relationship name="ComesFrom" from="Genome" to="Source" arity="MM">
490 :     <Notes>This relationship connects a genome to the sources that mapped it. A genome can
491 :     come from a single source or from a cooperation among multiple sources.</Notes>
492 :     </Relationship>
493 :     <Relationship name="IsMadeUpOf" from="Contig" to="Sequence" arity="1M">
494 :     <Notes>A contig is stored in the database as an ordered set of sequences. By splitting the
495 :     contig into sequences, we get a performance boost from only needing to keep small portions
496 :     of a contig in memory at any one time. This relationship connects the contig to its
497 :     constituent sequences.</Notes>
498 :     <Fields>
499 :     <Field name="len" type="int">
500 : parrello 1.15 <Notes>Length of the sequence.</Notes>
501 :     </Field>
502 : parrello 1.1 <Field name="start-position" type="int">
503 : parrello 1.15 <Notes>Index (1-based) of the point in the contig where this
504 :     sequence starts.</Notes>
505 :     </Field>
506 : parrello 1.1 </Fields>
507 :     <FromIndex>
508 :     <Notes>This index enables the application to find all of the sequences in
509 : parrello 1.8 a contig in order, and makes it easier to find a particular residue section.</Notes>
510 : parrello 1.1 <IndexFields>
511 :     <IndexField name="start-position" order="ascending" />
512 :     <IndexField name="len" order="ascending" />
513 :     </IndexFields>
514 :     </FromIndex>
515 :     </Relationship>
516 :     <Relationship name="IsTargetOfAnnotation" from="Feature" to="Annotation" arity="1M">
517 :     <Notes>This relationship connects a feature to its annotations.</Notes>
518 :     </Relationship>
519 :     <Relationship name="MadeAnnotation" from="SproutUser" to="Annotation" arity="1M">
520 :     <Notes>This relationship connects an annotation to the user who made it.</Notes>
521 :     </Relationship>
522 :     <Relationship name="ParticipatesIn" from="Genome" to="Subsystem" arity="MM">
523 :     <Notes>This relationship connects subsystems to the genomes that use
524 :     it. If the subsystem has been curated for the genome, then the subsystem's roles will also be
525 :     connected to the genome features through the [b]SSCell[/b] object.</Notes>
526 : parrello 1.15 <Fields>
527 :     <Field name="variant-code" type="key-string">
528 : parrello 1.20 <Notes>Code indicating the subsystem variant to which this
529 : parrello 1.15 genome belongs. Each subsystem can have multiple variants. A variant
530 : parrello 1.20 code of [b]-1[/b] indicates that the genome does not have a functional
531 :     variant of the subsystem. A variant code of [b]0[/b] indicates that
532 :     the genome's participation is considered iffy.</Notes>
533 : parrello 1.15 </Field>
534 :     </Fields>
535 :     <ToIndex>
536 :     <Notes>This index enables the application to find all of the genomes using
537 :     a subsystem in order by variant code, which is how we wish to display them
538 :     in the spreadsheets.</Notes>
539 :     <IndexFields>
540 :     <IndexField name="variant-code" order="ascending" />
541 :     </IndexFields>
542 :     </ToIndex>
543 : parrello 1.1 </Relationship>
544 :     <Relationship name="OccursInSubsystem" from="Role" to="Subsystem" arity="MM">
545 :     <Notes>This relationship connects roles to the subsystems that implement them. </Notes>
546 : parrello 1.15 <Fields>
547 :     <Field name="column-number" type="int">
548 :     <Notes>Column number for this role in the specified subsystem's
549 :     spreadsheet.</Notes>
550 :     </Field>
551 :     </Fields>
552 :     <ToIndex>
553 :     <Notes>This index enables the application to see the subsystem roles
554 :     in column order. The ordering of the roles is usually significant,
555 :     so it is important to preserve it.</Notes>
556 :     <IndexFields>
557 :     <IndexField name="column-number" order="ascending" />
558 :     </IndexFields>
559 :     </ToIndex>
560 : parrello 1.1 </Relationship>
561 :     <Relationship name="IsGenomeOf" from="Genome" to="SSCell" arity="1M">
562 :     <Notes>This relationship connects a subsystem's spreadsheet cell to the
563 :     genome for the spreadsheet column.</Notes>
564 :     </Relationship>
565 :     <Relationship name="IsRoleOf" from="Role" to="SSCell" arity="1M">
566 :     <Notes>This relationship connects a subsystem's spreadsheet cell to the
567 :     role for the spreadsheet row.</Notes>
568 :     </Relationship>
569 :     <Relationship name="ContainsFeature" from="SSCell" to="Feature" arity="MM">
570 :     <Notes>This relationship connects a subsystem's spreadsheet cell to the
571 :     features assigned to it.</Notes>
572 : parrello 1.15 <Fields>
573 :     <Field name="cluster-number" type="int">
574 :     <Notes>ID of this feature's cluster. Clusters represent families of
575 :     related proteins participating in a subsystem.</Notes>
576 :     </Field>
577 :     </Fields>
578 :     </Relationship>
579 :     <Relationship name="IsAComponentOf" from="Compound" to="Reaction" arity="MM">
580 :     <Notes>This relationship connects a reaction to the compounds that participate
581 :     in it.</Notes>
582 :     <Fields>
583 :     <Field name="product" type="boolean">
584 :     <Notes>TRUE if the compound is a product of the reaction, FALSE if
585 :     it is a substrate. When a reaction is written on paper in
586 :     chemical notation, the substrates are left of the arrow and the
587 :     products are to the right. Sorting on this field will cause
588 :     the substrates to appear first, followed by the products. If the
589 :     reaction is reversible, then the notion of substrates and products
590 :     is not at intuitive; however, a value here of FALSE still puts the
591 :     compound left of the arrow and a value of TRUE still puts it to the
592 :     right.</Notes>
593 :     </Field>
594 : parrello 1.19 <Field name="stoichiometry" type="key-string">
595 : parrello 1.15 <Notes>Number of molecules of the compound that participate in a
596 :     single instance of the reaction. For example, if a reaction
597 : parrello 1.19 produces two water molecules, the stoichiometry of water for the
598 : parrello 1.15 reaction would be two. When a reaction is written on paper in
599 : parrello 1.19 chemical notation, the stoichiometry is the number next to the
600 : parrello 1.15 chemical formula of the compound.</Notes>
601 :     </Field>
602 :     <Field name="main" type="boolean">
603 :     <Notes>TRUE if this compound is one of the main participants in
604 :     the reaction, else FALSE. It is permissible for none of the
605 :     compounds in the reaction to be considered main, in which
606 :     case this value would be FALSE for all of the relevant
607 :     compounds.</Notes>
608 :     </Field>
609 :     <Field name="loc" type="key-string">
610 :     <Notes>An optional character string that indicates the relative
611 :     position of this compound in the reaction's chemical formula. The
612 :     location affects the way the compounds present as we cross the
613 :     relationship from the reaction side. The product/substrate flag
614 :     comes first, then the value of this field, then the main flag.
615 :     The default value is an empty string; however, the empty string
616 :     sorts first, so if this field is used, it should probably be
617 :     used for every compound in the reaction.</Notes>
618 :     </Field>
619 : parrello 1.19 <Field name="discriminator" type="int">
620 :     <Notes>A unique ID for this record. The discriminator does not
621 :     provide any useful data, but it prevents identical records from
622 :     being collapsed by the SELECT DISTINCT command used by ERDB to
623 :     retrieve data.</Notes>
624 :     </Field>
625 : parrello 1.15 </Fields>
626 :     <ToIndex>
627 :     <Notes>This index presents the compounds in the reaction in the
628 :     order they should be displayed when writing it in chemical notation.
629 :     All the substrates appear before all the products, and within that
630 :     ordering, the main compounds appear first.</Notes>
631 : parrello 1.19 <IndexFields>
632 :     <IndexField name="product" order="ascending" />
633 :     <IndexField name="loc" order="ascending" />
634 :     <IndexField name="main" order="descending" />
635 :     </IndexFields>
636 : parrello 1.15 </ToIndex>
637 : parrello 1.1 </Relationship>
638 :     <Relationship name="IsLocatedIn" from="Feature" to="Contig" arity="MM">
639 :     <Notes>This relationship connects a feature to the contig segments that work together
640 :     to effect it. The segments are numbered sequentially starting from 1. The database is
641 :     required to place an upper limit on the length of each segment. If a segment is longer
642 :     than the maximum, it can be broken into smaller bits.
643 :     [p]The upper limit enables applications to locate all features that contain a specific
644 :     residue. For example, if the upper limit is 100 and we are looking for a feature that
645 :     contains residue 234 of contig [b]ABC[/b], we can look for features with a begin point
646 :     between 135 and 333. The results can then be filtered by direction and length of the
647 :     segment.</Notes>
648 :     <Fields>
649 :     <Field name="locN" type="int">
650 : parrello 1.8 <Notes>Sequence number of this segment.</Notes>
651 :     </Field>
652 : parrello 1.1 <Field name="beg" type="int">
653 : parrello 1.8 <Notes>Index (1-based) of the first residue in the contig that
654 :     belongs to the segment.</Notes>
655 :     </Field>
656 : parrello 1.1 <Field name="len" type="int">
657 : parrello 1.8 <Notes>Number of residues in the segment. A length of 0 identifies
658 :     a specific point between residues. This is the point before the residue if the direction
659 :     is forward and the point after the residue if the direction is backward.</Notes>
660 :     </Field>
661 : parrello 1.1 <Field name="dir" type="char">
662 : parrello 1.8 <Notes>Direction of the segment: [b]+[/b] if it is forward and
663 :     [b]-[/b] if it is backward.</Notes>
664 :     </Field>
665 : parrello 1.1 </Fields>
666 :     <FromIndex Unique="false">
667 :     <Notes>This index allows the application to find all the segments of a feature in
668 : parrello 1.8 the proper order.</Notes>
669 : parrello 1.1 <IndexFields>
670 :     <IndexField name="locN" order="ascending" />
671 :     </IndexFields>
672 :     </FromIndex>
673 :     <ToIndex>
674 :     <Notes>This index is the one used by applications to find all the feature
675 :     segments that contain a specific residue.</Notes>
676 :     <IndexFields>
677 :     <IndexField name="beg" order="ascending" />
678 :     </IndexFields>
679 :     </ToIndex>
680 :     </Relationship>
681 :     <Relationship name="IsBidirectionalBestHitOf" from="Feature" to="Feature" arity="MM">
682 :     <Notes>This relationship is one of two that relate features to each other. It
683 :     connects features that are very similar but on separate genomes. A
684 :     bidirectional best hit relationship exists between two features [b]A[/b]
685 :     and [b]B[/b] if [b]A[/b] is the best match for [b]B[/b] on [b]A[/b]'s genome
686 :     and [b]B[/b] is the best match for [b]A[/b] on [b]B[/b]'s genome. </Notes>
687 :     <Fields>
688 :     <Field name="genome" type="name-string">
689 : parrello 1.8 <Notes>ID of the genome containing the target (to) feature.</Notes>
690 :     </Field>
691 :     <Field name="sc" type="float">
692 :     <Notes>score for this relationship</Notes>
693 :     </Field>
694 : parrello 1.1 </Fields>
695 :     <FromIndex>
696 :     <Notes>This index allows the application to find a feature's best hit for
697 : parrello 1.8 a specific target genome.</Notes>
698 : parrello 1.1 <IndexFields>
699 :     <IndexField name="genome" order="ascending" />
700 :     </IndexFields>
701 :     </FromIndex>
702 :     </Relationship>
703 : parrello 1.8 <Relationship name="HasProperty" from="Feature" to="Property" arity="MM">
704 :     <Notes>This relationship connects a feature to its known property values.
705 :     The relationship contains text data that indicates the paper or organization
706 :     that discovered evidence that the feature possesses the property. So, for
707 :     example, if two papers presented evidence that a feature is essential,
708 :     there would be an instance of this relationship for both.</Notes>
709 :     <Fields>
710 :     <Field name="evidence" type="text">
711 :     <Notes>URL or citation of the paper or
712 :     institution that reported evidence of the relevant feature possessing
713 :     the specified property value.</Notes>
714 :     </Field>
715 :     </Fields>
716 :     </Relationship>
717 :     <Relationship name="RoleOccursIn" from="Role" to="Diagram" arity="MM">
718 :     <Notes>This relationship connects a role to the diagrams on which it
719 :     appears. A role frequently identifies an enzyme, and can appear in many
720 :     diagrams. A diagram generally contains many different roles.</Notes>
721 :     </Relationship>
722 :     <Relationship name="HasSSCell" from="Subsystem" to="SSCell" arity="1M">
723 :     <Notes>This relationship connects a subsystem to the spreadsheet cells
724 :     used to analyze and display it. The cells themselves can be thought of
725 :     as a grid with Roles on one axis and Genomes on the other. The
726 :     various features of the subsystem are then assigned to the cells.</Notes>
727 :     </Relationship>
728 :     <Relationship name="IsTrustedBy" from="SproutUser" to="SproutUser" arity="MM">
729 :     <Notes>This relationship identifies the users trusted by each
730 :     particular user. When viewing functional assignments, the
731 :     assignment displayed is the most recent one by a user trusted
732 :     by the current user. The current user implicitly trusts himself.
733 :     If no trusted users are specified in the database, the user
734 :     also implicitly trusts the user [b]FIG[/b].</Notes>
735 :     </Relationship>
736 : parrello 1.15 <Relationship name="ConsistsOfRoles" from="RoleSubset" to="Role" arity="MM">
737 :     <Notes>This relationship connects a role subset to the roles that it covers.
738 :     A subset is, essentially, a named group of roles belonging to a specific
739 :     subsystem, and this relationship effects that. Note that will a role
740 :     may belong to many subsystems, a subset belongs to only one subsystem,
741 :     and all roles in the subset must have that subsystem in common.</Notes>
742 :     </Relationship>
743 :     <Relationship name="ConsistsOfGenomes" from="GenomeSubset" to="Genome" arity="MM">
744 :     <Notes>This relationship connects a subset to the genomes that it covers.
745 :     A subset is, essentially, a named group of genomes participating in a specific
746 :     subsystem, and this relationship effects that. Note that while a genome
747 :     may belong to many subsystems, a subset belongs to only one subsystem,
748 :     and all genomes in the subset must have that subsystem in common.</Notes>
749 :     </Relationship>
750 :     <Relationship name="HasRoleSubset" from="Subsystem" to="RoleSubset" arity="1M">
751 :     <Notes>This relationship connects a subsystem to its constituent
752 :     role subsets. Note that some roles in a subsystem may not belong to a
753 :     subset, so the relationship between roles and subsystems cannot be
754 :     derived from the relationships going through the subset.</Notes>
755 :     </Relationship>
756 :     <Relationship name="HasGenomeSubset" from="Subsystem" to="GenomeSubset" arity="1M">
757 :     <Notes>This relationship connects a subsystem to its constituent
758 :     genome subsets. Note that some genomes in a subsystem may not belong to a
759 :     subset, so the relationship between genomes and subsystems cannot be
760 :     derived from the relationships going through the subset.</Notes>
761 :     </Relationship>
762 :     <Relationship name="Catalyzes" from="Role" to="Reaction" arity="MM">
763 :     <Notes>This relationship connects a role to the reactions it catalyzes.
764 :     The purpose of a role is to create proteins that trigger certain
765 :     chemical reactions. A single reaction can be triggered by many roles,
766 :     and a role can trigger many reactions.</Notes>
767 :     </Relationship>
768 : parrello 1.1 </Relationships>
769 :     </Database>

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3