Skip to content

Commit 05be09e

Browse files
committed
feat: Add "Format" to column descriptions
1 parent 7ba7e67 commit 05be09e

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

src/common-principles.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -545,6 +545,7 @@ and a guide for using macros can be found at
545545
"RECOMMENDED",
546546
"The description of the column.",
547547
),
548+
"Format": "OPTIONAL",
548549
"Levels": "RECOMMENDED",
549550
"Units": "RECOMMENDED",
550551
"Delimiter": "OPTIONAL",
@@ -555,6 +556,8 @@ and a guide for using macros can be found at
555556

556557
Please note that while both `Units` and `Levels` are RECOMMENDED, typically only one
557558
of these two fields would be specified for describing a single TSV file column.
559+
In the absence of `Format`, `Units` implies the column contains numeric values,
560+
and `Levels` implies the column contains strings.
558561

559562
Example:
560563

src/schema/objects/metadata.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1199,6 +1199,39 @@ FlipAngle:
11991199
unit: degree
12001200
exclusiveMinimum: 0
12011201
maximum: 360
1202+
Format:
1203+
name: Format
1204+
display_name: Value format
1205+
description: |
1206+
Permitted formats for values in the described column.
1207+
type: string
1208+
# Keep synced with objects.formats
1209+
enum:
1210+
# Type formats
1211+
- string
1212+
- number
1213+
- integer
1214+
- boolean
1215+
# Numeric/alphanumeric strings
1216+
- index
1217+
- label
1218+
# Dates/times
1219+
- date
1220+
- datetime
1221+
- time
1222+
# Units
1223+
- unit
1224+
# URIs
1225+
- uri
1226+
- rrid
1227+
- bids_uri
1228+
# Paths
1229+
- dataset_relative
1230+
- file_relative
1231+
- participant_relative
1232+
- stimuli_relative
1233+
# Miscellaneous
1234+
- hed_version
12021235
FrameAcquisitionDuration:
12031236
name: FrameAcquisitionDuration
12041237
display_name: Frame Acquisition Duration

0 commit comments

Comments
 (0)