Skip to content

Commit 278b935

Browse files
Moo-Marceffigies
andauthored
[FIX] Clarify use of session entity in file names (#532)
* Clarify when ses-<label> is optional Clarify that the ses-<label> entity is REQUIRED in file names when the session level is present in the folder structure. * Clarify when ses-<label> is optional Update to the entity table. It's actually required in some cases, and not to be used in others. It's never really optional... * Update 01-contributors.md * Revert changes to entity table. This reverts commit 7708479. * Update src/02-common-principles.md Co-authored-by: Chris Markiewicz <[email protected]> Co-authored-by: Chris Markiewicz <[email protected]>
1 parent 7f1f61f commit 278b935

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

src/02-common-principles.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,9 @@ A file name consists of a chain of *entities*, or key-value pairs, a *suffix* an
9999
Two prominent examples of entities are `subject` and `session`.
100100

101101
For a data file that was collected in a given `session` from a given
102-
`subject`, the file name will begin with the string `sub-<label>_ses-<label>`.
102+
`subject`, the file name MUST begin with the string `sub-<label>_ses-<label>`.
103+
If the `session` level is omitted in the folder structure, the file name MUST begin
104+
with the string `sub-<label>`, without `ses-<label>`.
103105

104106
Note that `sub-<label>` corresponds to the `subject` entity because it has
105107
the `sub-` "key" and`<label>` "value", where `<label>` would in a real data file

src/99-appendices/01-contributors.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ your name is not listed, please add it.
9292
- Gregory Kiar 📖💻🎨🔧
9393
- Robert Knight 📖
9494
- Jean-Philippe Lachaux 📖
95+
- Marc Lalancette 📖
9596
- Pamela LaMontagne 📖💡
9697
- Kevin Larcher 💬
9798
- Jonathan C. Lau 📖

0 commit comments

Comments
 (0)