From 3daf3584f5194eec30df16065b6138506f6fd450 Mon Sep 17 00:00:00 2001 From: Oscar Esteban Date: Tue, 27 Jun 2023 12:47:17 +0200 Subject: [PATCH 1/3] enh: add a Consistency principle Explicitly adds a new Consistency principle which I think it is implicit in the motivation and other principles, but I believe we need to make explicit to establish a shared standpoint to the interpretation of the specs. --- src/common-principles.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/common-principles.md b/src/common-principles.md index c268e19203..a06938ccf1 100644 --- a/src/common-principles.md +++ b/src/common-principles.md @@ -28,6 +28,13 @@ 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 From 7e6bf10ac80719c7c1ac90df8abcf5ecf4f730b6 Mon Sep 17 00:00:00 2001 From: Oscar Esteban Date: Tue, 27 Jun 2023 14:01:32 +0200 Subject: [PATCH 2/3] fix: add newline to close quote block --- src/common-principles.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/common-principles.md b/src/common-principles.md index a06938ccf1..78e263d5e2 100644 --- a/src/common-principles.md +++ b/src/common-principles.md @@ -32,6 +32,7 @@ A guide for using macros can be found at 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. From b9432e8708b92fe2aa8537609896a708ec1475ad Mon Sep 17 00:00:00 2001 From: Oscar Esteban Date: Tue, 27 Jun 2023 14:17:15 +0200 Subject: [PATCH 3/3] enh: add breaklines --- src/common-principles.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/src/common-principles.md b/src/common-principles.md index 78e263d5e2..2e7a66c2cb 100644 --- a/src/common-principles.md +++ b/src/common-principles.md @@ -30,11 +30,19 @@ A guide for using macros can be found at ## 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. +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