Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] Add a Consistency principle to Common principles #1530

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[ENH] Add a Consistency principle to Common principles #1530

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3daf358
enh: add a Consistency principle
oesteban Jun 27, 2023
7e6bf10
fix: add newline to close quote block
oesteban Jun 27, 2023
b9432e8
enh: add breaklines
oesteban Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/common-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@ A guide for using macros can be found at
-->
{{ MACROS___define_common_principles() }}

## Consistency principle

To effectively implement the underpinning motivation of this data structure,
it is fundamental that all the specifications and extensions of BIDS
are based on a principle of consistency, stated as follows:
> Given the same original dataset generated by a neuroimaging acquisition device,
two different researchers who possess thorough knowledge of BIDS (and of the original
source's formats) should independently generate a "virtually" identical BIDS structure
when tasked with the conversion of the data into BIDS.

Here, "virtually" highlights the fact that some aspects of this specification are OPTIONAL,
and therefore can be freely chosen by the BIDS encoder.
For example, the "participant" labels chosen by one researcher could be
a zero padded index based at one, and the other could choose hexadecimal encoding,
while the dataset would remain "virtually" identical.

## Entities

An "entity" is an attribute that can be associated with a file, contributing
Expand Down