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

[FIX] Discourage use of "sample" in events if sampling frequency is ambiguous, add guidelines for precision #1140

Merged
merged 4 commits into from
Jul 22, 2022
Merged
Show file tree
Hide file tree
Changes from 3 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
10 changes: 8 additions & 2 deletions src/04-modality-specific-files/05-task-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,22 @@ and a guide for using macros can be found at
}
) }}

<sup>5</sup> Note for MRI data:
Note for MRI data:
If any acquired scans have been discarded before forming the imaging data file,
ensure that an `onset` of 0 corresponds to the time the first image was stored.
For example in case there is an in scanner training phase that
begins before the scanning sequence has started events from this sequence should
have negative onset time counting down to the beginning of the acquisition of
the first volume.

Note regarding the precision of numeric metadata:
It is RECOMMENDENDED that dataset curators specify numeric metadata like `onset` and
`duration` with as much decimal precision as is reasonable in the context of the experiment.
For example in an EEG experiment with devices operating at 1000 Hz sampling frequency,
dataset curators SHOULD specify **at least** 3 figures after the decimal point.

An arbitrary number of additional columns can be added. Those allow describing
other properties of events that could be later referred in modelling and
other properties of events that could be later referenced in modelling and
hypothesis extensions of BIDS.
Note that the `trial_type` and any additional columns in a TSV file
SHOULD be documented in an accompanying JSON sidecar file.
Expand Down
3 changes: 3 additions & 0 deletions src/schema/objects/columns.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,9 @@ sample:
description: |
Onset of the event according to the sampling scheme of the recorded modality
(that is, referring to the raw data file that the `events.tsv` file accompanies).
When there are several sampling schemes present in the raw data file (as can be
the case for example for `.edf` files), this metadata field is ambiguous and
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
SHOULD NOT be used.
type: integer
sample_id:
name: sample_id
Expand Down