From 957d6b88da60331f5e322cc44f3d854a4e507e1f Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Tue, 12 Jul 2022 12:11:29 +0200 Subject: [PATCH 1/4] [FIX] add note to 'sample' in events --- src/schema/objects/columns.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/schema/objects/columns.yaml b/src/schema/objects/columns.yaml index b4cf79852b..f10f6d964f 100644 --- a/src/schema/objects/columns.yaml +++ b/src/schema/objects/columns.yaml @@ -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 + SHOULD NOT be used. type: integer sample_id: name: sample_id From c616251248ed604f0359d3791dc4444f4c46e89c Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Tue, 12 Jul 2022 12:16:07 +0200 Subject: [PATCH 2/4] add note for precision --- src/04-modality-specific-files/05-task-events.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/04-modality-specific-files/05-task-events.md b/src/04-modality-specific-files/05-task-events.md index 407f9ebc86..b61b962f16 100644 --- a/src/04-modality-specific-files/05-task-events.md +++ b/src/04-modality-specific-files/05-task-events.md @@ -52,7 +52,7 @@ and a guide for using macros can be found at } ) }} -5 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 @@ -60,6 +60,12 @@ 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 hypothesis extensions of BIDS. From f1fbc9d3a9283f48a0df8d2bde93421dca669799 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Tue, 12 Jul 2022 13:40:03 +0200 Subject: [PATCH 3/4] referred -> referenced --- src/04-modality-specific-files/05-task-events.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/04-modality-specific-files/05-task-events.md b/src/04-modality-specific-files/05-task-events.md index b61b962f16..5b76a27943 100644 --- a/src/04-modality-specific-files/05-task-events.md +++ b/src/04-modality-specific-files/05-task-events.md @@ -67,7 +67,7 @@ For example in an EEG experiment with devices operating at 1000 Hz sampling freq 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. From 2692bf5552442608c1ab63100b2194c452ff68b6 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 14 Jul 2022 21:51:29 +0200 Subject: [PATCH 4/4] Update src/schema/objects/columns.yaml Co-authored-by: Taylor Salo --- src/schema/objects/columns.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/schema/objects/columns.yaml b/src/schema/objects/columns.yaml index f10f6d964f..60dda15844 100644 --- a/src/schema/objects/columns.yaml +++ b/src/schema/objects/columns.yaml @@ -348,7 +348,7 @@ sample: 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 + the case for example for `.edf` files), this column is ambiguous and SHOULD NOT be used. type: integer sample_id: