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

Jump to bottom

[MISC] add "forward slash" requirement for paths to common principles #867

Merged
merged 4 commits into from
Jan 31, 2022
Merged

[MISC] add "forward slash" requirement for paths to common principles #867

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63f47d1
add forward slash path requirement to common principles
sappelhoff Sep 2, 2021
5e224f6
clarify absolute paths and relative paths
sappelhoff Nov 8, 2021
369c49a
Merge branch 'master' into common_principles/forward-slash-paths
sappelhoff Jan 23, 2022
7a60b76
go from must to should
sappelhoff Jan 23, 2022
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
14 changes: 14 additions & 0 deletions src/02-common-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,20 @@ it refers to. For example `sub-01` refers to the `sub` entity (a
subject) with the label `01`. The `sub-` prefix is not part of the subject
label, but must be included in file names (similarly to other key names).

## Specification of paths

Several metadata fields in BIDS require the specification of paths,
that is a string of characters used to uniquely identify a location in a directory structure.
For example the `IntendedFor` or `AssociatedEmptyroom` metadata fields.

Throughout BIDS all such paths MUST be specified using the slash character (`/`),
regardless of the operating system that a particular dataset is curated on or used on.

Paths MUST NOT be absolute local paths,
because these might break when a dataset is used on a different machine.
Thus, all paths specified in a BIDS dataset must be relative paths,
as specified in the respective descriptions of metadata fields that require the use of paths.

## Uniform Resource Indicator

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