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

[FIX] Clarify case collision intolerance as a file naming principle #858

Merged
merged 4 commits into from
Sep 28, 2021
Merged

[FIX] Clarify case collision intolerance as a file naming principle #858

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82e9beb
BF: inform that no to <label> can be identical if casing is ignored
yarikoptic Aug 20, 2021
958125c
RF: move collision intollerance to subsection of "Participant names a…
yarikoptic Aug 31, 2021
9b74f54
ENH: reference section with more information on labels within Definit…
yarikoptic Aug 31, 2021
6fc3745
ENH: Make case collision intolerance a general file naming principle
effigies Sep 13, 2021
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
12 changes: 11 additions & 1 deletion src/02-common-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ misunderstanding we clarify them here.

1. **`<label>`** - an alphanumeric value, possibly prefixed with arbitrary
number of 0s for consistent indentation, for example, it is `rest` in `task-rest`
following `task-<label>` specification.
following `task-<label>` specification. Note that labels MUST not collide when
casing is ignored (see [Case collision intolerance](#case-collision-intolerance)).

1. **`suffix`** - an alphanumeric value, located after the `key-value_` pairs (thus after
the final `_`), right before the **File extension**, for example, it is `eeg` in
Expand Down Expand Up @@ -218,6 +219,15 @@ Use cases concerning this convention are compiled in the
[file collections](./99-appendices/10-file-collections.md) appendix.
This convention is mainly intended for but not limited to MRI modalities.

### Case collision intolerance

File name components are case sensitive,
but collisions MUST be avoided when casing is ignored.
For example, a dataset cannot contain both `sub-s1` and `sub-S1`,
as the labels would collide on a case-insensitive filesystem.
Additionally, because the suffix `eeg` is defined,
then the suffix `EEG` will not be added to future versions of the standard.

## Source vs. raw vs. derived data

BIDS was originally designed to describe and apply consistent naming conventions
Expand Down