Skip to content

Commit

Permalink
[FIX] Clarify use of session entity in file names (#532)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
Moo-Marc and effigies authored Aug 10, 2020
1 parent 7f1f61f commit 278b935
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/02-common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,9 @@ A file name consists of a chain of *entities*, or key-value pairs, a *suffix* an
Two prominent examples of entities are `subject` and `session`.

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

Note that `sub-<label>` corresponds to the `subject` entity because it has
the `sub-` "key" and`<label>` "value", where `<label>` would in a real data file
Expand Down
1 change: 1 addition & 0 deletions src/99-appendices/01-contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ your name is not listed, please add it.
- Gregory Kiar πŸ“–πŸ’»πŸŽ¨πŸ”§
- Robert Knight πŸ“–
- Jean-Philippe Lachaux πŸ“–
- Marc Lalancette πŸ“–
- Pamela LaMontagne πŸ“–πŸ’‘
- Kevin Larcher πŸ’¬
- Jonathan C. Lau πŸ“–
Expand Down

0 comments on commit 278b935

Please sign in to comment.