Skip to content

Conversation

@effigies
Copy link
Collaborator

@effigies effigies commented Feb 28, 2024

This PR proposes the inclusion of BEP-038 into the BIDS specification.

The BEP is hosted on its own branch in the main repository, and BEP leads have been given write permissions to the branch. If you are a BEP lead and having issues writing to the branch, please let a maintainer know and we can make sure you have access.

At present this is a starting point, and I anticipate significant rewriting and reorganization before final merge. There is extensive discussion in #1281 that needs to be turned into concrete proposals. I would suggest keeping the discussion on this PR minimal so that newcomers can follow the thread. When opening PRs against this branch, please include a reference to this PR (#1714) so that it shows up in the thread.

Rendered draft

https://bids-specification--1714.org.readthedocs.build/en/1714/derivatives/atlas.html

Related discussions

Associated PRs

melanieganz and others added 17 commits January 23, 2024 09:23
I made a first draft of the atlas BEP based on the Google doc
Added atlas content
All the content of the BEP038 Google document has been ported to the atlas.md file. Additionally atlas and a definition of what of means was added as an entity. There are still smaller things to fix as some links, references and the tables still need to be inserted.
Fixed details such as linking to entities and suffixes as well as clarified some of the example text.  The tables need still to be fixed.
[BEP038] Style and similar cleanups
@CPernet
Copy link
Collaborator

CPernet commented Mar 31, 2024

@erdalkaraca @tsalo this has passed the review period now, can this be checked and merged? thx

@oesteban
Copy link
Collaborator

oesteban commented Apr 1, 2024

I'm working on a review. Please hold on.

@effigies
Copy link
Collaborator Author

effigies commented Apr 1, 2024

I also have not finished my review/proposed changes. I am unlikely to get to it before the meeting next week as I am traveling for another meeting this week.

@effigies
Copy link
Collaborator Author

effigies commented Apr 4, 2024

This BEP currently needs:

  1. Schema implementation of required checks and filename rules
  2. Examples implementing all significant (ideally all) features proposed to https://github.com/bids-standard/bids-examples
  3. Implementation of all rules in https://github.com/bids-standard/bids-validator and tested on the examples.
  4. A two week public review period announced on all communication channels.

I'm converting this to draft to reflect this status. I'm going to temporarily restrict comments, pending synchronous discussion.

@effigies effigies marked this pull request as draft April 4, 2024 19:53
@bids-standard bids-standard locked as too heated and limited conversation to collaborators Apr 4, 2024
@christinerogers christinerogers marked this pull request as ready for review April 5, 2024 17:02
@sappelhoff sappelhoff marked this pull request as draft April 5, 2024 17:12
level: error
selectors:
- dataset.dataset_description.DatasetType == "derivative"
- entities.atlas
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- entities.atlas
- entities.atlas
- entities.template

Atlas description isn't required in case of atlas based derivatives.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The selected <label> in the atlas-<label>_description.json file is RECOMMENDED for the [atlas-<label> entity](https://bids-specification--1714.org.readthedocs.build/en/1714/appendices/entities.html#atlas) in downstream derivatives from this particular atlas (see previous section [Derivatives from atlases](https://bids-specification--1714.org.readthedocs.build/en/1714/derivatives/imaging.html#derivatives-from-atlases)).

Though it is recommended.

@effigies effigies closed this Nov 10, 2025
@effigies effigies reopened this Nov 10, 2025
@effigies effigies marked this pull request as ready for review November 10, 2025 14:53
effigies and others added 2 commits November 12, 2025 22:18
Co-authored-by: Mathieu Guay-Paquet <[email protected]>
Co-authored-by: Mathieu Guay-Paquet <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.