Skip to content

Commit 49940de

Browse files
Address review comments: improve events documentation clarity
- Remove 'task' from 'task events section' references - Reword events.md introduction to be more inclusive of non-task events - Fix grammar: 'Please mind' to 'Please keep in mind' - Clarify that 'Each events.tsv file' (not just 'events file') - Update historical references in changelogs
1 parent d1a472d commit 49940de

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

src/common-principles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,7 @@ Example of a hypothetical `*_bold.json` file, accompanying a `*_bold.nii` file:
677677
Example of a hypothetical `*_events.json` file, accompanying an
678678
`*_events.tsv` file. Note that the JSON file contains a key describing an
679679
*arbitrary* column `stim_presentation_side` in the TSV file it accompanies.
680-
See [task events section](modality-agnostic-files/events.md)
680+
See [events section](modality-agnostic-files/events.md)
681681
for more information.
682682

683683
```JSON

src/modality-agnostic-files/events.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
The purpose of this file is to describe timing and other properties of events
44
recorded during data acquisition.
5-
Events are, for example, stimuli presented to the participant or participant responses
6-
during acquisition of functional data and thus associated with specific tasks performed
7-
(see [Definitions](../common-principles.md#definitions)).
5+
Events may include stimuli presented to the participant, participant responses
6+
that are associated with tasks, or markers of other incidents that occurred
7+
during the execution of the experiment.
8+
See the [definition of Event](../common-principles.md#definitions) for a more detailed explanation.
89
A single event file MAY include any combination of stimulus, response, and other events.
910
Events MAY overlap in time.
10-
Please mind that this does not imply that only so called "event related" study designs
11+
Please keep in mind that this does not imply that only so called "event related" study designs
1112
are supported (in contrast to "block" designs) - each "block of events" can be
1213
represented by an individual row in the `events.tsv` file (with a long
1314
duration).
@@ -19,7 +20,7 @@ duration).
1920
)
2021
}}
2122

22-
Each events file REQUIRES a corresponding data file.
23+
Each `events.tsv` file REQUIRES a corresponding data file.
2324
It is also possible to have a single `events.tsv` file describing events
2425
for all participants and runs (see
2526
[Inheritance Principle](../common-principles.md#the-inheritance-principle)).

src/pregh-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
- Added support for MEG data (merged BEP008).
1111
- Added `SequenceName` field.
12-
- Added support for describing events with Hierarchical Event Descriptors: [4.3 Task events](modality-agnostic-files/events.md).
12+
- Added support for describing events with Hierarchical Event Descriptors: [4.3 Events](modality-agnostic-files/events.md).
1313
- Added `VolumeTiming` and `AcquisitionDuration` fields: [4.1 Task (including resting state) imaging data](modality-specific-files/magnetic-resonance-imaging-data.md#task-including-resting-state-imaging-data).
1414
- Added `DwellTime` field.
1515

0 commit comments

Comments
 (0)