search

bids-standard / bep001

Project management repository (primarily issues) for BIDS Extension Proposal 001
Creative Commons Attribution 4.0 International
8 stars 11 forks source link

Guidelines on extending the specification #77

Closed KirstieJane closed 4 years ago

KirstieJane commented 4 years ago

The following text is taken from #59 (written by @agahkarakuzu).

@Gilles86 and I think that although the guidelines on extending the grouping suffices table are really useful, they are for folks looking to extend the BIDS specification rather than readers of the specification itself.

So I've copied and pasted them here so they don't get lost (they should be in a paper for sure to justify how we came up with the proposal, and potentially in some governance for extending BIDS more generally)....just not in the standard.

Some important considerations regarding grouping suffixes:

  • All grouping suffixes MUST be capitalized.
  • Grouping suffixes MUST attain a clear description of the qMRI application that they relate to. Hyperlinks to example applications and/or more detailed descriptions are encouraged whenever possible.
  • Unless the pulse sequence is exclusively associated with a specific qMRI application (e.g. MP2RAGE), sequence names are NOT used as grouping suffixes.
  • If it is possible to derive a qMRI application from an already existing grouping suffix by defining a set of logical conditions over the metadata fields, the table of method-specific priority levels and the table of qMRI applications that can be derived from an existing grouping suffix MUST be expanded instead of introducing a new grouping suffix. Please visit the JSON content for grouping suffixes for further details.
  • Please note that if a structural data has the type of grouped scan collection, the use of _suffix alone cannot distinguish its members from each other, failing to identify their roles as inputs to the calculation of qMRI maps. Although such images are REQUIRED to be grouped by a proper grouping suffix, they are also RECOMMENDED to include at least one of the acq, part and indexable_metadata entities (please visit corresponding sections for details).