You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specifications/enzymeml.md
+44-41Lines changed: 44 additions & 41 deletions
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ EnzymeML is a data exchange format that supports the comprehensive documentation
16
16
17
17
This is the root object that composes all objects found in an EnzymeML document. It also includes general metadata such as the name of the document, when it was created/modified, and references to publications, databases, and arbitrary links to the web.
18
18
19
-
-__name__
19
+
-**name**
20
20
- Type: string
21
21
- Description: Title of the EnzymeML Document.
22
22
- Term: schema:title
@@ -67,15 +67,15 @@ This is the root object that composes all objects found in an EnzymeML document.
67
67
68
68
The creator object contains all information about authors that contributed to the resulting document.
69
69
70
-
-__given_name__
70
+
-**given_name**
71
71
- Type: string
72
72
- Description: Given name of the author or contributor.
73
73
- Term: schema:givenName
74
-
-__family_name__
74
+
-**family_name**
75
75
- Type: string
76
76
- Description: Family name of the author or contributor.
77
77
- Term: schema:familyName
78
-
-__mail__
78
+
-**mail**
79
79
- Type: string
80
80
- Description: Email address of the author or contributor.
81
81
- Term: schema:email
@@ -86,22 +86,22 @@ The creator object contains all information about authors that contributed to th
86
86
87
87
This object describes vessels in which the experiment has been carried out. These can include any type of vessel used in biocatalytic experiments.
88
88
89
-
-__id__
89
+
-**id**
90
90
- Type: Identifier
91
91
- Description: Unique identifier of the vessel.
92
92
- Term: schema:identifier
93
-
-__name__
93
+
-**name**
94
94
- Type: string
95
95
- Description: Name of the used vessel.
96
96
- Term: schema:name
97
-
-__volume__
97
+
-**volume**
98
98
- Type: float
99
99
- Description: Volumetric value of the vessel.
100
100
- Term: OBO:OBI_0002139
101
-
-__unit__
101
+
-**unit**
102
102
- Type: UnitDefinition
103
103
- Description: Volumetric unit of the vessel.
104
-
-__constant__
104
+
-**constant**
105
105
- Type: boolean
106
106
- Description: Whether the volume of the vessel is constant or not.
107
107
- Default: True
@@ -110,14 +110,14 @@ This object describes vessels in which the experiment has been carried out. Thes
110
110
111
111
This object describes the proteins that were used or formed throughout the experiment.
112
112
113
-
-__id__
113
+
-**id**
114
114
- Type: Identifier
115
115
- Description: Unique internal identifier of the protein.
116
116
- schema:identifier
117
-
-__name__
117
+
-**name**
118
118
- Type: string
119
119
- Term: schema:name
120
-
-__constant__
120
+
-**constant**
121
121
- Type: boolean
122
122
- Default: False
123
123
- sequence
@@ -143,21 +143,24 @@ This object describes the proteins that were used or formed throughout the exper
143
143
- Description: Array of references to publications, database entries, etc. that describe the protein.
144
144
- Term: schema:citation
145
145
146
-
147
146
### Complex
148
147
149
148
This object describes complexes made of reactants and/or proteins that were used or produced in the course of the experiment.
150
149
151
-
-__id__
150
+
-**id**
152
151
- Type: Identifier
153
152
- Description: Unique identifier of the complex.
154
153
- Term: schema:identifier
155
-
-__name__
154
+
-**name**
156
155
- Type: string
157
156
- Term: schema:name
158
-
-__constant__
157
+
-**constant**
159
158
- Type: boolean
160
159
- Default: False
160
+
- vessel_id
161
+
- Type: Identifier
162
+
- Description: Unique identifier of the vessel this complex has been used in.
163
+
- Term: schema:identifier
161
164
- participants
162
165
- Type: Identifier[]
163
166
- Description: Array of IDs the complex contains
@@ -166,14 +169,14 @@ This object describes complexes made of reactants and/or proteins that were used
166
169
167
170
This object describes the reactants that were used or produced in the course of the experiment.
168
171
169
-
-__id__
172
+
-**id**
170
173
- Type: Identifier
171
174
- Description: Unique identifier of the small molecule.
172
175
- Term: schema:identifier
173
-
-__name__
176
+
-**name**
174
177
- Type: string
175
178
- Term: schema:name
176
-
-__constant__
179
+
-**constant**
177
180
- Type: boolean
178
181
- Default: False
179
182
- vessel_id
@@ -200,14 +203,14 @@ This object describes the reactants that were used or produced in the course of
200
203
201
204
This object describes a chemical or enzymatic reaction that was investigated in the course of the experiment. All species used within this object need to be part of the data model.
202
205
203
-
-__id__
206
+
-**id**
204
207
- Type: Identifier
205
208
- Description: Unique identifier of the reaction.
206
209
- Term: schema:identifier
207
-
-__name__
210
+
-**name**
208
211
- Type: string
209
212
- Description: Name of the reaction.
210
-
-__reversible__
213
+
-**reversible**
211
214
- Type: boolean
212
215
- Description: Whether the reaction is reversible or irreversible
213
216
- Default: False
@@ -225,11 +228,11 @@ This object describes a chemical or enzymatic reaction that was investigated in
225
228
226
229
This object is part of the Reaction object and describes either an educt, product or modifier. The latter includes buffers, counter-ions as well as proteins/enzymes.
227
230
228
-
-__species_id__
231
+
-**species_id**
229
232
- Type: Identifier
230
233
- Description: Internal identifier to either a protein or reactant defined in the EnzymeMLDocument.
231
234
- schema:identifier
232
-
-__stoichiometry__
235
+
-**stoichiometry**
233
236
- Type: float
234
237
- Description: Float number representing the associated stoichiometry.
235
238
@@ -242,10 +245,10 @@ This object describes an equation that can be used to model the kinetics of a re
242
245
- species_id
243
246
- Type: Identifier
244
247
- Description: Internal identifier to a species defined in the EnzymeMLDocument, given it is a rate equation.
245
-
-__equation__
248
+
-**equation**
246
249
- Type: string
247
250
- Description: Mathematical expression of the equation.
248
-
-__equation_type__
251
+
-**equation_type**
249
252
- Type: EquationType
250
253
- Description: Type of the equation.
251
254
- variables
@@ -256,29 +259,29 @@ This object describes an equation that can be used to model the kinetics of a re
256
259
257
260
This object describes a variable that is part of an equation.
258
261
259
-
-__id__
262
+
-**id**
260
263
- Type: string
261
264
- Description: Unique identifier of the variable.
262
265
- Term: schema:identifier
263
-
-__name__
266
+
-**name**
264
267
- Type: string
265
268
- Description: Name of the variable.
266
-
-__symbol__
269
+
-**symbol**
267
270
- Type: string
268
271
- Description: Symbol of the variable.
269
272
270
273
### Parameter
271
274
272
275
This object describes the parameters of the kinetic model and can include all estimated values.
273
276
274
-
-__id__
277
+
-**id**
275
278
- Type: Identifier
276
279
- Description: Unique identifier of the parameter.
277
280
- Term: schema:identifier
278
-
-__name__
281
+
-**name**
279
282
- Type: string
280
283
- Description: Name of the parameter.
281
-
-__symbol__
284
+
-**symbol**
282
285
- Type: string
283
286
- Description: Symbol of the parameter.
284
287
- value
@@ -310,11 +313,11 @@ This object describes the parameters of the kinetic model and can include all es
310
313
311
314
This object describes the result of a measurement, which includes time course data of any type defined in DataTypes. It includes initial concentrations of all species used in a single measurement.
312
315
313
-
-__id__
316
+
-**id**
314
317
- Type: Identifier
315
318
- Description: Unique identifier of the measurement.
316
319
- Term: schema:identifier
317
-
-__name__
320
+
-**name**
318
321
- Type: string
319
322
- Description: Name of the measurement
320
323
- species_data
@@ -339,16 +342,16 @@ This object describes the result of a measurement, which includes time course da
339
342
340
343
This object describes a single entity of a measurement, which corresponds to one species. It also holds replicates that contain time course data.
341
344
342
-
-__species_id__
345
+
-**species_id**
343
346
- Type: Identifier
344
347
- Description: The identifier for the described reactant.
345
348
- prepared
346
-
- Type: float
347
-
- Description: Amount of the reactant before the measurement. This field should be used for specifying the prepared amount of a species in the reaction mix. Not to be confused with `initial`, specifying the concentration at the first data point from the `data` array.
348
-
-__initial__
349
+
- Type: float
350
+
- Description: Amount of the reactant before the measurement. This field should be used for specifying the prepared amount of a species in the reaction mix. Not to be confused with `initial`, specifying the concentration at the first data point from the `data` array.
351
+
-**initial**
349
352
- Type: float
350
353
- Description: Initial amount of the measurement data. This must be the same as the first data point in the `data` array.
351
-
-__data_unit__
354
+
-**data_unit**
352
355
- Type: UnitDefinition
353
356
- Description: SI unit of the data that was measured.
354
357
- data
@@ -360,10 +363,10 @@ This object describes a single entity of a measurement, which corresponds to one
360
363
- time_unit
361
364
- Type: UnitDefinition
362
365
- Description: Time unit of the replicate.
363
-
-__data_type__
366
+
-**data_type**
364
367
- Type: DataTypes
365
368
- Description: Type of data that was measured (e.g. concentration)
366
-
-__is_simulated__
369
+
-**is_simulated**
367
370
- Type: boolean
368
371
- Description: Whether or not the data has been generated by simulation.
0 commit comments