Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SCHEMA] Add MeasurementToolMetadata and Derivative metadata fields #899

Merged
merged 2 commits into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions src/03-modality-agnostic-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,12 +363,15 @@ in the BIDS dataset and `participants.tsv` file.
As with all other tabular data, the additional phenotypic information files
MAY be accompanied by a JSON file describing the columns in detail
(see [Tabular files](02-common-principles.md#tabular-files)).
In addition to the column description, a section describing the measurement tool
(as a whole) MAY be added under the name `MeasurementToolMetadata`.
This section consists of two keys:

- `Description`: A free text description of the measurement tool
- `TermURL`: A URL to an entity in an ontology corresponding to this tool.
In addition to the column descriptions, the JSON file MAY contain the following fields:

{{ MACROS___make_metadata_table(
{
"MeasurementToolMetadata": "OPTIONAL",
"Derivative": "OPTIONAL",
}
) }}

As an example, consider the contents of a file called
`phenotype/acds_adult.json`:
Expand Down
21 changes: 21 additions & 0 deletions src/schema/objects/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,13 @@ Density:
- type: object
additionalProperties:
type: string
Derivative:
name: Derivative
description: |
Indicates that values in the corresponding column are transformations of values
from other columns (for example a summary score based on a subset of items in a
questionnaire).
type: boolean
Description:
name: Description
description: |
Expand Down Expand Up @@ -1549,6 +1556,20 @@ MaxMovement:
as measured by the head localisation coils (for example, 4.8).
type: number
unit: mm
MeasurementToolMetadata:
name: MeasurementToolMetadata
description: |
A description of the measurement tool as a whole.
Contains two fields: `"Description"` and `"TermURL"`.
`"Description"` is a free text description of the measurement tool.
`"TermURL"` is a URL to an entity in an ontology corresponding to this tool.
type: object
properties:
TermURL:
type: string
format: uri
Description:
type: string
MetaboliteAvail:
name: MetaboliteAvail
description: |
Expand Down