Skip to content

Commit 5fe26e1

Browse files
authored
[MISC] add "forward slash" requirement for paths to common principles (bids-standard#867)
* add forward slash path requirement to common principles * clarify absolute paths and relative paths * go from must to should
1 parent f544835 commit 5fe26e1

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/02-common-principles.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -661,6 +661,20 @@ it refers to. For example `sub-01` refers to the `sub` entity (a
661661
subject) with the label `01`. The `sub-` prefix is not part of the subject
662662
label, but must be included in filenames (similarly to other key names).
663663

664+
## Specification of paths
665+
666+
Several metadata fields in BIDS require the specification of paths,
667+
that is, a string of characters used to uniquely identify a location in a directory structure.
668+
For example the `IntendedFor` or `AssociatedEmptyroom` metadata fields.
669+
670+
Throughout BIDS all such paths MUST be specified using the slash character (`/`),
671+
regardless of the operating system that a particular dataset is curated on or used on.
672+
673+
Paths SHOULD NOT be absolute local paths,
674+
because these might break when a dataset is used on a different machine.
675+
It is RECOMMENDED that all paths specified in a BIDS dataset are relative paths,
676+
as specified in the respective descriptions of metadata fields that require the use of paths.
677+
664678
## Uniform Resource Indicator
665679

666680
A Uniform Resource Indicator (URI) is a string referring to a resource and SHOULD

0 commit comments

Comments
 (0)