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

[ENH] Make explicit that "task" metadata applies to "beh" modality #804

Merged
merged 14 commits into from
Aug 2, 2021
Merged
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ JSON file.
{
"RepetitionTime": "REQUIRED",
"VolumeTiming": "REQUIRED",
"TaskName": "REQUIRED",
"TaskName": ("REQUIRED", "A RECOMMENDED convention is to name resting state task using labels beginning with `rest`.")
}
) }}

Expand Down Expand Up @@ -513,7 +513,7 @@ sparse sequences.

{{ MACROS___make_metadata_table(
{
"Instructions": "RECOMMENDED",
"Instructions": ("RECOMMENDED", "This is especially important in context of resting state recordings and distinguishing between eyes open and eyes closed paradigms."),
"TaskDescription": "RECOMMENDED",
"CogAtlasID": "RECOMMENDED",
"CogPOID": "RECOMMENDED",
Expand Down
4 changes: 2 additions & 2 deletions src/04-modality-specific-files/02-magnetoencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Generic fields MUST be present:

{{ MACROS___make_metadata_table(
{
"TaskName": "REQUIRED",
"TaskName": ("REQUIRED", "A RECOMMENDED convention is to name resting state task using labels beginning with `rest`."),
}
) }}

Expand All @@ -109,7 +109,7 @@ Whenever possible, please avoid using ad-hoc wording.
),
"SoftwareVersions": "RECOMMENDED",
"TaskDescription": "RECOMMENDED",
"Instructions": "RECOMMENDED",
"Instructions": ("RECOMMENDED", "This is especially important in context of resting state recordings and distinguishing between eyes open and eyes closed paradigms."),
"CogAtlasID": "RECOMMENDED",
"CogPOID": "RECOMMENDED",
"DeviceSerialNumber": "RECOMMENDED",
Expand Down
4 changes: 2 additions & 2 deletions src/04-modality-specific-files/03-electroencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Generic fields MUST be present:

{{ MACROS___make_metadata_table(
{
"TaskName": "REQUIRED",
"TaskName": ("REQUIRED", "A RECOMMENDED convention is to name resting state task using labels beginning with `rest`."),
}
) }}

Expand All @@ -104,7 +104,7 @@ Whenever possible, please avoid using ad hoc wording.
"ManufacturersModelName": "RECOMMENDED",
"SoftwareVersions": "RECOMMENDED",
"TaskDescription": "RECOMMENDED",
"Instructions": "RECOMMENDED",
"Instructions": ("RECOMMENDED", "This is especially important in context of resting state recordings and distinguishing between eyes open and eyes closed paradigms."),
"CogAtlasID": "RECOMMENDED",
"CogPOID": "RECOMMENDED",
"DeviceSerialNumber": "RECOMMENDED",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Generic fields MUST be present:

{{ MACROS___make_metadata_table(
{
"TaskName": "REQUIRED",
"TaskName": ("REQUIRED", "A RECOMMENDED convention is to name resting state task using labels beginning with `rest`."),
}
) }}

Expand All @@ -112,7 +112,7 @@ Whenever possible, please avoid using ad hoc wording.
"ManufacturersModelName": "RECOMMENDED",
"SoftwareVersions": "RECOMMENDED",
"TaskDescription": "RECOMMENDED",
"Instructions": "RECOMMENDED",
"Instructions": ("RECOMMENDED", "This is especially important in context of resting state recordings and distinguishing between eyes open and eyes closed paradigms."),
"CogAtlasID": "RECOMMENDED",
"CogPOID": "RECOMMENDED",
"DeviceSerialNumber": "RECOMMENDED",
Expand Down
23 changes: 23 additions & 0 deletions src/04-modality-specific-files/07-behavioral-experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,31 @@ Additionally, events files that do not include the mandatory `onset` and
`duration` columns can still be included, but should be labeled `_beh.tsv`
rather than `_events.tsv`.

Each task has a unique label that MUST only consist of letters and/or numbers
(other characters, including spaces and underscores, are not allowed) with the
[`task-<label>`](../99-appendices/09-entities.md#task) key/value pair.
Those labels MUST be consistent across subjects and sessions.

The OPTIONAL [`acq-<label>`](../99-appendices/09-entities.md#acq) key/value pair corresponds to a custom label to
distinguish different conditions present during multiple runs of the same task.
For example, if a study includes runs of an n-back task, with deep brain
stimulation turned on or off, the data files may be labelled
`sub-01_task-nback_acq-dbson_beh.tsv` and `sub-01_task-nback_acq-dbsoff_beh.tsv`.

## RECOMMENDED metadata

In addition of the metadata REQUIRED for some data that can be found in the `beh` folder
(for example `SamplingFrequency` and `StartTime` for `*_<physio|stim>.tsv.gz` files),
it is RECOMMENDED to add the following metadata to the JSON files of this folder.

{{ MACROS___make_metadata_table(
{
"TaskName": "RECOMMENDED",
"Instructions": "RECOMMENDED",
"TaskDescription": "RECOMMENDED",
"CogAtlasID": "RECOMMENDED",
"CogPOID": "RECOMMENDED",
"InstitutionName": "RECOMMENDED",
"InstitutionAddress": "RECOMMENDED",
}
) }}
2 changes: 0 additions & 2 deletions src/schema/metadata/Instructions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@
name: Instructions
description: |
Text of the instructions given to participants before the recording.
This is especially important in context of resting state recordings and
distinguishing between eyes open and eyes closed paradigms.
type: string
2 changes: 0 additions & 2 deletions src/schema/metadata/TaskName.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,4 @@ description: |
by removing all non-alphanumeric (`[a-zA-Z0-9]`) characters.
For example `TaskName` `"faces n-back"` will correspond to task label
`facesnback`.
A RECOMMENDED convention is to name resting state task using labels beginning
with `rest`.
type: string