Skip to content

Commit c8ca20e

Browse files
committed
add vessel_id to Complex
1 parent 79403da commit c8ca20e

File tree

1 file changed

+44
-41
lines changed

1 file changed

+44
-41
lines changed

specifications/enzymeml.md

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ EnzymeML is a data exchange format that supports the comprehensive documentation
1616

1717
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.
1818

19-
- __name__
19+
- **name**
2020
- Type: string
2121
- Description: Title of the EnzymeML Document.
2222
- Term: schema:title
@@ -67,15 +67,15 @@ This is the root object that composes all objects found in an EnzymeML document.
6767

6868
The creator object contains all information about authors that contributed to the resulting document.
6969

70-
- __given_name__
70+
- **given_name**
7171
- Type: string
7272
- Description: Given name of the author or contributor.
7373
- Term: schema:givenName
74-
- __family_name__
74+
- **family_name**
7575
- Type: string
7676
- Description: Family name of the author or contributor.
7777
- Term: schema:familyName
78-
- __mail__
78+
- **mail**
7979
- Type: string
8080
- Description: Email address of the author or contributor.
8181
- Term: schema:email
@@ -86,22 +86,22 @@ The creator object contains all information about authors that contributed to th
8686

8787
This object describes vessels in which the experiment has been carried out. These can include any type of vessel used in biocatalytic experiments.
8888

89-
- __id__
89+
- **id**
9090
- Type: Identifier
9191
- Description: Unique identifier of the vessel.
9292
- Term: schema:identifier
93-
- __name__
93+
- **name**
9494
- Type: string
9595
- Description: Name of the used vessel.
9696
- Term: schema:name
97-
- __volume__
97+
- **volume**
9898
- Type: float
9999
- Description: Volumetric value of the vessel.
100100
- Term: OBO:OBI_0002139
101-
- __unit__
101+
- **unit**
102102
- Type: UnitDefinition
103103
- Description: Volumetric unit of the vessel.
104-
- __constant__
104+
- **constant**
105105
- Type: boolean
106106
- Description: Whether the volume of the vessel is constant or not.
107107
- Default: True
@@ -110,14 +110,14 @@ This object describes vessels in which the experiment has been carried out. Thes
110110

111111
This object describes the proteins that were used or formed throughout the experiment.
112112

113-
- __id__
113+
- **id**
114114
- Type: Identifier
115115
- Description: Unique internal identifier of the protein.
116116
- schema:identifier
117-
- __name__
117+
- **name**
118118
- Type: string
119119
- Term: schema:name
120-
- __constant__
120+
- **constant**
121121
- Type: boolean
122122
- Default: False
123123
- sequence
@@ -143,21 +143,24 @@ This object describes the proteins that were used or formed throughout the exper
143143
- Description: Array of references to publications, database entries, etc. that describe the protein.
144144
- Term: schema:citation
145145

146-
147146
### Complex
148147

149148
This object describes complexes made of reactants and/or proteins that were used or produced in the course of the experiment.
150149

151-
- __id__
150+
- **id**
152151
- Type: Identifier
153152
- Description: Unique identifier of the complex.
154153
- Term: schema:identifier
155-
- __name__
154+
- **name**
156155
- Type: string
157156
- Term: schema:name
158-
- __constant__
157+
- **constant**
159158
- Type: boolean
160159
- 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
161164
- participants
162165
- Type: Identifier[]
163166
- Description: Array of IDs the complex contains
@@ -166,14 +169,14 @@ This object describes complexes made of reactants and/or proteins that were used
166169

167170
This object describes the reactants that were used or produced in the course of the experiment.
168171

169-
- __id__
172+
- **id**
170173
- Type: Identifier
171174
- Description: Unique identifier of the small molecule.
172175
- Term: schema:identifier
173-
- __name__
176+
- **name**
174177
- Type: string
175178
- Term: schema:name
176-
- __constant__
179+
- **constant**
177180
- Type: boolean
178181
- Default: False
179182
- vessel_id
@@ -200,14 +203,14 @@ This object describes the reactants that were used or produced in the course of
200203

201204
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.
202205

203-
- __id__
206+
- **id**
204207
- Type: Identifier
205208
- Description: Unique identifier of the reaction.
206209
- Term: schema:identifier
207-
- __name__
210+
- **name**
208211
- Type: string
209212
- Description: Name of the reaction.
210-
- __reversible__
213+
- **reversible**
211214
- Type: boolean
212215
- Description: Whether the reaction is reversible or irreversible
213216
- Default: False
@@ -225,11 +228,11 @@ This object describes a chemical or enzymatic reaction that was investigated in
225228

226229
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.
227230

228-
- __species_id__
231+
- **species_id**
229232
- Type: Identifier
230233
- Description: Internal identifier to either a protein or reactant defined in the EnzymeMLDocument.
231234
- schema:identifier
232-
- __stoichiometry__
235+
- **stoichiometry**
233236
- Type: float
234237
- Description: Float number representing the associated stoichiometry.
235238

@@ -242,10 +245,10 @@ This object describes an equation that can be used to model the kinetics of a re
242245
- species_id
243246
- Type: Identifier
244247
- Description: Internal identifier to a species defined in the EnzymeMLDocument, given it is a rate equation.
245-
- __equation__
248+
- **equation**
246249
- Type: string
247250
- Description: Mathematical expression of the equation.
248-
- __equation_type__
251+
- **equation_type**
249252
- Type: EquationType
250253
- Description: Type of the equation.
251254
- variables
@@ -256,29 +259,29 @@ This object describes an equation that can be used to model the kinetics of a re
256259

257260
This object describes a variable that is part of an equation.
258261

259-
- __id__
262+
- **id**
260263
- Type: string
261264
- Description: Unique identifier of the variable.
262265
- Term: schema:identifier
263-
- __name__
266+
- **name**
264267
- Type: string
265268
- Description: Name of the variable.
266-
- __symbol__
269+
- **symbol**
267270
- Type: string
268271
- Description: Symbol of the variable.
269272

270273
### Parameter
271274

272275
This object describes the parameters of the kinetic model and can include all estimated values.
273276

274-
- __id__
277+
- **id**
275278
- Type: Identifier
276279
- Description: Unique identifier of the parameter.
277280
- Term: schema:identifier
278-
- __name__
281+
- **name**
279282
- Type: string
280283
- Description: Name of the parameter.
281-
- __symbol__
284+
- **symbol**
282285
- Type: string
283286
- Description: Symbol of the parameter.
284287
- value
@@ -310,11 +313,11 @@ This object describes the parameters of the kinetic model and can include all es
310313

311314
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.
312315

313-
- __id__
316+
- **id**
314317
- Type: Identifier
315318
- Description: Unique identifier of the measurement.
316319
- Term: schema:identifier
317-
- __name__
320+
- **name**
318321
- Type: string
319322
- Description: Name of the measurement
320323
- species_data
@@ -339,16 +342,16 @@ This object describes the result of a measurement, which includes time course da
339342

340343
This object describes a single entity of a measurement, which corresponds to one species. It also holds replicates that contain time course data.
341344

342-
- __species_id__
345+
- **species_id**
343346
- Type: Identifier
344347
- Description: The identifier for the described reactant.
345348
- 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**
349352
- Type: float
350353
- 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**
352355
- Type: UnitDefinition
353356
- Description: SI unit of the data that was measured.
354357
- data
@@ -360,10 +363,10 @@ This object describes a single entity of a measurement, which corresponds to one
360363
- time_unit
361364
- Type: UnitDefinition
362365
- Description: Time unit of the replicate.
363-
- __data_type__
366+
- **data_type**
364367
- Type: DataTypes
365368
- Description: Type of data that was measured (e.g. concentration)
366-
- __is_simulated__
369+
- **is_simulated**
367370
- Type: boolean
368371
- Description: Whether or not the data has been generated by simulation.
369372
- Default: False

0 commit comments

Comments
 (0)