/
tumorml.rng
708 lines (706 loc) · 21.1 KB
/
tumorml.rng
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
<?xml version="1.0" encoding="UTF-8"?>
<!--
RELAX NG schema for TumorML 1.2
Author: David Johnson
Contributors: Stelios Sfakianakis
Created with oXygen XML editor
Copyright (c) 2012-2013, University of Oxford; 2013-, TumorML contributors.
The TumorML schema is distributed under the terms of the GNU Lesser General Public License (LGPL)
http://www.gnu.org/licenses/lgpl.html
-->
<grammar ns="http://www.tumor-project.eu/tumorml/1.2" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
<!-- Regex for alphanumeric combinations w/ underscores OR MIRIAM URIs -->
<define name="ident">
<data type="token">
<param name="pattern">(_*[0-9a-zA-Z][\w_]*)|(urn:miriam:[0-9a-zA-Z][\w]*:[0-9a-zA-Z][\w]*)|(urn:miriam:[0-9a-zA-Z][\w]*\.[0-9a-zA-Z][\w]*:[0-9a-zA-Z][\w:\.]*)|(urn:orcid:[0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9])|(urn:[0-9a-zA-Z][\w]*\.[0-9a-zA-Z][\w]*:[0-9a-zA-Z][\w]*:[0-9a-zA-Z][\w]*)</param>
</data>
</define>
<define name="url">
<data type="token">
<param name="pattern">[hH][tT]{2}[pP]://[wW]{3}.*</param>
</data>
</define>
<!-- Tumor Model Taxonomy -->
<define name="mathType">
<choice>
<value type="string" datatypeLibrary="">discrete</value>
<value type="string" datatypeLibrary="">continuous</value>
<value type="string" datatypeLibrary="">hybrid</value>
</choice>
</define>
<define name="multiScaleType">
<choice>
<value type="string" datatypeLibrary="">topDown</value>
<value type="string" datatypeLibrary="">bottomUp</value>
<value type="string" datatypeLibrary="">middleOut</value>
</choice>
</define>
<define name="singleScaleType">
<choice>
<value type="string" datatypeLibrary="">gene</value>
<value type="string" datatypeLibrary="">subcellular</value>
<value type="string" datatypeLibrary="">cell</value>
<value type="string" datatypeLibrary="">tissue</value>
<value type="string" datatypeLibrary="">organ</value>
</choice>
</define>
<define name="cancerType">
<choice>
<value type="string" datatypeLibrary="">glioma</value>
<value type="string" datatypeLibrary="">glioblastoma</value>
<value type="string" datatypeLibrary="">nephroblastoma</value>
<value type="string" datatypeLibrary="">lung</value>
<value type="string" datatypeLibrary="">breast</value>
<value type="string" datatypeLibrary="">generic</value>
</choice>
</define>
<define name="homogeneityType">
<choice>
<value type="string" datatypeLibrary="">homogeneous</value>
<value type="string" datatypeLibrary="">non-homogeneous</value>
</choice>
</define>
<!--
JSDL types
n.b. Restricted due to TUMOR repository DB schema restrictions
-->
<define name="osType">
<choice>
<value type="string" datatypeLibrary="">unknown</value>
<value type="string" datatypeLibrary="">linux</value>
<value type="string" datatypeLibrary="">winNT</value>
<value type="string" datatypeLibrary="">macOS</value>
<value type="string" datatypeLibrary="">winXP</value>
<value type="string" datatypeLibrary="">winVista</value>
<value type="string" datatypeLibrary="">win7</value>
<value type="string" datatypeLibrary="">solaris</value>
<value type="string" datatypeLibrary="">sunOS</value>
<value type="string" datatypeLibrary="">javaVM</value>
</choice>
</define>
<define name="cpuType">
<choice>
<value type="string" datatypeLibrary="">sparc</value>
<value type="string" datatypeLibrary="">powerpc</value>
<value type="string" datatypeLibrary="">x86</value>
<value type="string" datatypeLibrary="">x86_32</value>
<value type="string" datatypeLibrary="">x86_64</value>
<value type="string" datatypeLibrary="">parisc</value>
<value type="string" datatypeLibrary="">mips</value>
<value type="string" datatypeLibrary="">ia64</value>
<value type="string" datatypeLibrary="">arm</value>
<value type="string" datatypeLibrary="">other</value>
</choice>
</define>
<define name="langType">
<choice>
<value type="string" datatypeLibrary="">c</value>
<value type="string" datatypeLibrary="">cpp</value>
<value type="string" datatypeLibrary="">java</value>
<value type="string" datatypeLibrary="">python</value>
<value type="string" datatypeLibrary="">perl</value>
<value type="string" datatypeLibrary="">fortran</value>
<value type="string" datatypeLibrary="">bash</value>
<value type="string" datatypeLibrary="">multiple</value>
<value type="string" datatypeLibrary="">matlab</value>
</choice>
</define>
<define name="commandLineDataTypes">
<choice>
<value type="string" datatypeLibrary="">int</value>
<value type="string" datatypeLibrary="">double</value>
<value type="string" datatypeLibrary="">filename</value>
<value type="string" datatypeLibrary="">string</value>
</choice>
</define>
<!--
some simple Dublin Core elements
n.b. Simplified due to TUMOR repository DB schema restrictions
-->
<define name="dc_elements">
<interleave>
<element name="title">
<text/>
</element>
<optional>
<element name="creator">
<ref name="person"/>
</element>
</optional>
<optional>
<element name="description">
<text/>
</element>
</optional>
<optional>
<element name="publisher">
<ref name="person"/>
</element>
</optional>
<zeroOrMore>
<element name="contributor">
<ref name="person"/>
</element>
</zeroOrMore>
<element name="date">
<data type="dateTime"/>
</element>
</interleave>
</define>
<!--
some simple xCard (vCard) elements describing an individual person, including a TUMOR user ID
n.b. Simplified due to TUMOR repository DB schema restrictions
-->
<define name="person">
<element name="person">
<attribute name="id">
<ref name="ident"/>
</attribute>
<optional>
<element name="fullname">
<text/>
</element>
</optional>
<optional>
<element name="name">
<element name="surname">
<text/>
</element>
<element name="given">
<text/>
</element>
<zeroOrMore>
<element name="prefix">
<text/>
</element>
</zeroOrMore>
<zeroOrMore>
<element name="suffix">
<text/>
</element>
</zeroOrMore>
</element>
</optional>
<zeroOrMore>
<element name="email">
<text/>
</element>
</zeroOrMore>
<zeroOrMore>
<element name="org">
<text/>
</element>
</zeroOrMore>
</element>
</define>
<!--
TUMOR repository specific metadata
n.b. Based on TUMOR repository DB schema
-->
<define name="tumor_elements">
<interleave>
<optional>
<element name="math">
<choice>
<ref name="mathType"/>
<text/>
</choice>
</element>
</optional>
<optional>
<element name="singleScale">
<choice>
<ref name="singleScaleType"/>
<text/>
</choice>
</element>
</optional>
<optional>
<element name="multiScale">
<choice>
<ref name="multiScaleType"/>
<text/>
</choice>
</element>
</optional>
<optional>
<element name="cancer">
<choice>
<ref name="cancerType"/>
<text/>
</choice>
</element>
</optional>
<optional>
<element name="homogeneity">
<choice>
<ref name="homogeneityType"/>
<text/>
</choice>
</element>
</optional>
<optional>
<element name="freeGrowth">
<data type="boolean"/>
</element>
</optional>
<optional>
<element name="treatmentIncluded">
<data type="boolean"/>
</element>
</optional>
</interleave>
</define>
<!--
External references
n.b. Based on TUMOR repository DB schema
-->
<!-- bibType is based on BibTeX -->
<define name="bibType">
<choice>
<value type="string" datatypeLibrary="">article</value>
<value type="string" datatypeLibrary="">book</value>
<value type="string" datatypeLibrary="">booklet</value>
<value type="string" datatypeLibrary="">manual</value>
<value type="string" datatypeLibrary="">techreport</value>
<value type="string" datatypeLibrary="">mastersthesis</value>
<value type="string" datatypeLibrary="">phdthesis</value>
<value type="string" datatypeLibrary="">inbook</value>
<value type="string" datatypeLibrary="">incollection</value>
<value type="string" datatypeLibrary="">proceedings</value>
<value type="string" datatypeLibrary="">inproceedings</value>
<value type="string" datatypeLibrary="">conference</value>
<value type="string" datatypeLibrary="">unpublished</value>
<value type="string" datatypeLibrary="">misc</value>
</choice>
</define>
<define name="reference">
<element name="reference">
<interleave>
<element name="title">
<text/>
</element>
<optional>
<element name="source">
<text/>
</element>
</optional>
<optional>
<element name="creator">
<text/>
</element>
</optional>
<optional>
<element name="citation">
<text/>
</element>
</optional>
<element name="type">
<choice>
<ref name="bibType"/>
<text/>
</choice>
</element>
</interleave>
</element>
</define>
<!--
SI base units based on NIST Reference
http://physics.nist.gov/cuu/Units/current.html
-->
<define name="siBaseUnitTypes">
<choice>
<value type="string" datatypeLibrary="">meter</value>
<value type="string" datatypeLibrary="">kilogram</value>
<value type="string" datatypeLibrary="">second</value>
<value type="string" datatypeLibrary="">ampere</value>
<value type="string" datatypeLibrary="">kelvin</value>
<value type="string" datatypeLibrary="">mole</value>
<value type="string" datatypeLibrary="">candela</value>
</choice>
</define>
<!-- Some extra non standard units used in cancer modelling, e.g. arbitrary counts -->
<define name="tumorExtraUnitTypes">
<choice>
<value type="string" datatypeLibrary="">item</value>
<value type="string" datatypeLibrary="">gray</value>
</choice>
</define>
<!-- Combined lists of unit types used in TumorML -->
<define name="unitTypes">
<choice>
<ref name="siBaseUnitTypes"/>
<ref name="tumorExtraUnitTypes"/>
</choice>
</define>
<!-- or derived unit name -->
<!-- Units model -->
<define name="derivedUnit">
<element name="derivedUnit">
<attribute name="name"/>
<oneOrMore>
<element name="unit">
<attribute name="name"/>
<optional>
<attribute name="multiplier">
<data type="int"/>
</attribute>
</optional>
<optional>
<attribute name="offset">
<data type="int"/>
</attribute>
</optional>
<optional>
<attribute name="scale">
<data type="int"/>
</attribute>
</optional>
<optional>
<attribute name="exp">
<data type="int"/>
</attribute>
</optional>
</element>
</oneOrMore>
</element>
</define>
<!-- Each TumorML model has an ID to lookup in the repository -->
<start>
<ref name="tumorml"/>
</start>
<define name="tumorml_id">
<attribute name="id">
<ref name="ident"/>
</attribute>
</define>
<!-- Basic structure is a model ID, header containing metadata, followed by the model description -->
<define name="tumorml">
<element name="tumorml">
<ref name="tumorml_id"/>
<ref name="header"/>
<ref name="model"/>
</element>
</define>
<!--
The header contains metadata as:
* Dublin Core elements
* TUMOR repository DB specific elements
* Bibliographical references (optional)
-->
<define name="header">
<element name="header">
<interleave>
<ref name="dc_elements"/>
<ref name="tumor_elements"/>
<zeroOrMore>
<ref name="reference"/>
</zeroOrMore>
</interleave>
</element>
</define>
<!--
The model description contains either:
1) a simple model as
* One or more implementations
* A input/output parameters profile
or
2) a complex model as
* Multiple submodels
* A model instance topology
-->
<define name="model">
<element name="model">
<choice>
<ref name="simpleModel"/>
<ref name="complexModel"/>
</choice>
</element>
</define>
<define name="simpleModel">
<ref name="parameters"/>
<oneOrMore>
<ref name="implementation"/>
</oneOrMore>
</define>
<define name="complexModel">
<ref name="submodel"/>
<oneOrMore>
<ref name="submodel"/>
</oneOrMore>
<ref name="topology"/>
</define>
<!--
Each implementation contains:
* Metadata as Dublin Core and any number of bibliographic references (optional)
* A package file name
* A command line to initiate model execution
* A list of runtime environment requirements
-->
<define name="implementation">
<element name="implementation">
<interleave>
<attribute name="id">
<ref name="ident"/>
</attribute>
<ref name="dc_elements"/>
<zeroOrMore>
<ref name="reference"/>
</zeroOrMore>
<ref name="package"/>
<ref name="command"/>
<ref name="requirements"/>
</interleave>
</element>
</define>
<!-- A package consists of a package name and a list of files -->
<define name="package">
<element name="package">
<interleave>
<attribute name="name"/>
<attribute name="checksum"/>
<oneOrMore>
<ref name="file"/>
</oneOrMore>
</interleave>
</element>
</define>
<!-- A file has a name, a full path relative to the package root, and a checksum (optional) -->
<define name="fname">
<data type="token">
<param name="pattern">[A-Za-z0-9\\-\\._]+</param>
</data>
</define>
<!-- not tested yet -->
<define name="file">
<element name="file">
<interleave>
<attribute name="name">
<ref name="fname"/>
</attribute>
<!-- regex describing valid filenames -->
<attribute name="source">
<ref name="ident"/>
</attribute>
<optional>
<!-- refer to URN within DB -->
<attribute name="checksum"/>
</optional>
</interleave>
</element>
</define>
<!-- A command is a simple string for now. -->
<define name="command">
<element name="command">
<text/>
</element>
</define>
<!-- TODO replace with a suitable regex -->
<!--
The requirements include:
* Operating system (optional)
* CPU architecture (optional)
* Languages that need to be supported (optional, can be multiple)
-->
<define name="requirements">
<element name="requirements">
<interleave>
<optional>
<element name="operatingSystem">
<ref name="osType"/>
</element>
</optional>
<optional>
<element name="CPUArchitecture">
<ref name="cpuType"/>
</element>
</optional>
<zeroOrMore>
<element name="language">
<ref name="langType"/>
</element>
</zeroOrMore>
</interleave>
</element>
</define>
<!--
Each submodel has a unique ID and:
* All the elements of a simple model
or
* All the elements of a complex model
-->
<define name="submodel">
<element name="submodel">
<choice>
<group>
<attribute name="id">
<ref name="ident"/>
</attribute>
<ref name="simpleModel"/>
</group>
<ref name="complexModel"/>
</choice>
</element>
</define>
<!-- A topology declares a 2 or more instances and at least one coupling of instance parameters together -->
<define name="topology">
<element name="topology">
<ref name="instance"/>
<oneOrMore>
<ref name="instance"/>
</oneOrMore>
<oneOrMore>
<ref name="coupling"/>
</oneOrMore>
</element>
</define>
<!-- An instance has a unique ID, references a submodel by ID and has a multiplicity (currently fixed) -->
<define name="instance">
<element name="instance">
<interleave>
<attribute name="id">
<ref name="ident"/>
</attribute>
<attribute name="submodel">
<ref name="ident"/>
</attribute>
<optional>
<attribute name="multiplicity">
<data type="int"/>
</attribute>
</optional>
</interleave>
</element>
</define>
<!--
A coupling refers to a specific parameter of two different submodels
* from submodel.parameter
* to submodel.parameter
-->
<define name="coupling">
<element name="coupling">
<interleave>
<attribute name="from">
<ref name="ident"/>
</attribute>
<attribute name="to">
<ref name="ident"/>
</attribute>
</interleave>
</element>
</define>
<!--
The parameters element defines at least on input parameter and multiple output parameters
n.b. There must be at least one input parameter
-->
<define name="parameters">
<element name="parameters">
<interleave>
<zeroOrMore>
<element name="units">
<oneOrMore>
<ref name="derivedUnit"/>
</oneOrMore>
</element>
</zeroOrMore>
<oneOrMore>
<element name="in">
<ref name="parameter"/>
</element>
</oneOrMore>
<zeroOrMore>
<element name="out">
<ref name="parameter"/>
</element>
</zeroOrMore>
</interleave>
</element>
</define>
<!--
Parameters consist of:
* A unique ID/name
* A label (optional)
* A description (optional)
* Whether or not this parameter is optional (optional)
* A value descriptor (optional)
* The descriptor contains a datatype, optional default value, and optional value range
* A unit constraint, based on SI prefix and base units (optional)
regardless of whether they are inputs or outputs
-->
<define name="parameter">
<interleave>
<attribute name="name">
<ref name="ident"/>
</attribute>
<optional>
<attribute name="label"/>
</optional>
<optional>
<attribute name="optional">
<data type="boolean"/>
</attribute>
</optional>
<optional>
<element name="description">
<text/>
</element>
</optional>
<optional>
<element name="concept_id">
<ref name="url"/>
</element>
</optional>
<element name="value">
<interleave>
<attribute name="type">
<ref name="commandLineDataTypes"/>
</attribute>
<optional>
<attribute name="default"/>
</optional>
<optional>
<element name="range">
<interleave>
<optional>
<element name="min">
<interleave>
<optional>
<attribute name="inclusive">
<data type="boolean"/>
</attribute>
</optional>
<text/>
</interleave>
</element>
</optional>
<optional>
<element name="max">
<interleave>
<optional>
<attribute name="inclusive">
<data type="boolean"/>
</attribute>
</optional>
<text/>
</interleave>
</element>
</optional>
</interleave>
</element>
</optional>
<optional>
<element name="unit">
<!-- SI unit, or an ID referencing a derived unit -->
<attribute name="type">
<choice>
<ref name="unitTypes"/>
<ref name="ident"/>
</choice>
</attribute>
</element>
</optional>
</interleave>
</element>
</interleave>
</define>
</grammar>