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] add details for content of *_beh.json #902

Merged
merged 7 commits into from
Nov 10, 2021
Merged
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
35 changes: 32 additions & 3 deletions src/04-modality-specific-files/07-behavioral-experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,14 @@ stimulation turned on or off, the data files may be labelled

## 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.
In addition to the metadata that is either:

- RECOMMENDED for sidecar JSON files for [tabular data](../02-common-principles.md#tabular-data), or

- 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(
{
Expand All @@ -43,3 +48,27 @@ it is RECOMMENDED to add the following metadata to the JSON files of this folder
"InstitutionalDepartmentName": "RECOMMENDED",
}
) }}

Example of the content of a `_beh.tsv` and its accompanying `_beh.json` sidecar file:

```Text
trial response response_time stim_file
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
congruent red 1.435 images/word-red_color-red.jpg
incongruent red 1.739 images/word-red_color-blue.jpg
```

In the accompanying JSON sidecar, the `trial` column might be documented as follows:

```JSON
{
"TaskName": "Stroop",
"trial": {
"LongName": "Trial name",
"Description": "Indicator of the type of trial",
"Levels": {
"congruent": "Word and font color match.",
"incongruent": "Word and font color do not match."
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
```