[ENH] BEP044 - Stim-BIDS #2022
Open
[ENH] BEP044 - Stim-BIDS #2022
+442
−20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implement the standardization of stimulus files and their annotations within the BIDS specifications.
* **Add new file `src/modality-specific-files/stimuli.md`**
- Describe the specifications for the stimuli directory.
- Include guidelines for storing stimulus files and their annotations.
- Define what goes into `stimuli.tsv/json`, `annotations.tsv/json`, and `stim-<label>.json`.
- Use the same style as other modality-specific docs to design the tables, variables, and examples.
* **Modify `src/modality-specific-files/task-events.md`**
- Add a section detailing the standardization of stimulus files and their annotations within the BIDS specifications.
- Include examples of how to use the `stim_file` and `stim_id` columns in `events.tsv` files.
- Provide guidelines for storing stimulus files in the `/stimuli` directory.
- Expand the definition of the `stim_file` column to include `stim_id`.
* **Modify `src/schema/objects/columns.yaml`**
- Update the definition of the `stim_file` column to ensure consistency in stimulus file references.
- Add the `stim_id` column definition for `events.tsv` files.
* **Modify `src/schema/rules/checks/events.yaml`**
- Add a check for missing stimulus files declared in `events.tsv`.
- Add a check for missing `stim_id` references in `events.tsv`.
* **Modify `src/schema/rules/sidecars/events.yaml`**
- Specify the `StimulusPresentation` metadata field for `events.tsv` files.
- Include the `stim_id` column in the metadata field specifications.
* **Modify `src/schema/objects/entities.yaml`**
- Add entities described in the document with proper requirement levels and descriptions.
* **Modify `src/schema/objects/suffixes.yaml`**
- Add suffixes for `{audio, image, video, audiovideo}`.
- Include the file extensions and descriptions for each suffix.
* **Add new file `src/schema/rules/sidecars/stimulus.yaml`**
- Define sidecar tables for `stimuli.tsv/json`, `annotations.tsv/json`, and `stim-<label>.json`.
- Use the same style as other modality-specific docs to design the tables.
---
For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/neuromechanist/bids-specification?shareId=XXXX-XXXX-XXXX-XXXX).
Add stimuli specifications to BIDS
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses #153 by introducing specifications for handling and standardizing stimulus files and their annotations within the BIDS specifications. The changes focus on improving the organization, referencing, and metadata of stimulus files to enhance consistency, reusability, and efficiency.
Here are the relevant links and documents:
Known issues:
/src/schema/rules/files/rawrequiredatatype. Stimuli might be a special data type that can only be present at the root of the dataset. So, the datatype field is missing for now.cc: @bids-standard/bep044 and @monique2208