Skip to content

Commit 8bc1f61

Browse files
authored
doc(schema): Add definition field for objects.columns entries (#2046)
1 parent 0a8f910 commit 8bc1f61

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/schema/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,13 @@ These objects additionally have the field:
399399
| `type` | The type (such as `string`, `integer`, `object`) of values the term describes |
400400
| `format` | The format of the term (defined in `objects.formats`) |
401401

402+
`objects.columns` additionally permit a `definition` field that may take any value permissible
403+
for the definition of a column in a JSON sidecar:
404+
405+
| Field | Description |
406+
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
407+
| `definition` | A JSON object that describes the column as in [Common principles - Tabular files][tabular files]. This is mutually exclusive with the `type` field, and is used for fields that have overridable definitions. |
408+
402409
Value terms groups (`datatypes`, `suffixes`, `extensions`) define terms where a field
403410
can take on multiple values.
404411
For example, a file has one datatype, as compared to a collection of entities.
@@ -532,6 +539,7 @@ The convention can be summed up in the following rules:
532539
| `display_name` | Human-friendly name |
533540
| `description` | Term definition |
534541
| `name` | Name of column in TSV file (in `snake_case`) |
542+
| `definition` | JSON definition of a column, according to [Tabular files][] |
535543
| `unit` | Interpretation of numeric values |
536544
| `type` | Type of value |
537545
| `format` | Permissible format of values, from definitions in `objects.formats` |
@@ -1052,3 +1060,5 @@ formalize the allowable directories, files, fields and values of the BIDS schema
10521060
ensuring consistency across the entire schema directory. Validation of the schema is
10531061
incorporated into the CI, so any changes that are inconsistent will be flagged before
10541062
inclusion.
1063+
1064+
[tabular files]: https://bids-specification.readthedocs.io/en/stable/common-principles.html#tabular-files

0 commit comments

Comments
 (0)