Skip to content

Commit 99eec00

Browse files
adam2392sappelhofftsalo
authored
[MISC] Clarify participant_id in participants.tsv file if it exists (#738)
* Adding clarification. * Fix clarifications. * Fix link. * Apply suggestions from code review Co-authored-by: Stefan Appelhoff <[email protected]> * Add link back. * Update src/06-longitudinal-and-multi-site-studies.md * Apply suggestions from code review Co-authored-by: Taylor Salo <[email protected]> * Update src/06-longitudinal-and-multi-site-studies.md Co-authored-by: Taylor Salo <[email protected]> * Fix docs. * line breaks Co-authored-by: Stefan Appelhoff <[email protected]> Co-authored-by: Taylor Salo <[email protected]>
1 parent 9cb5612 commit 99eec00

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

src/03-modality-agnostic-files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,9 @@ participants.json
162162

163163
The purpose of this RECOMMENDED file is to describe properties of participants
164164
such as age, sex, handedness.
165-
In case of single-session studies, this file has one compulsory column
166-
`participant_id` that consists of `sub-<label>`, followed by a list of optional
167-
columns describing participants.
165+
If this file exists, it MUST contain the column `participant_id`,
166+
which MUST consist of `sub-<label>` values identifying one row for each participant,
167+
followed by a list of optional columns describing participants.
168168
Each participant MUST be described by one and only one row.
169169

170170
Commonly used *optional* columns in `participant.tsv` files are `age`, `sex`,

src/06-longitudinal-and-multi-site-studies.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Longitudinal and multi-site studies
22

33
Multiple sessions (visits) are encoded by adding an extra layer of directories
4-
and file names in the form of `ses-<label>`. Session label can consist
5-
only of alphanumeric characters `[a-zA-Z0-9]` and should be consistent across
6-
subjects. If numbers are used in session labels we recommend using zero padding
4+
and file names in the form of `ses-<label>`.
5+
Session labels MUST consist only of alphanumeric characters `[a-zA-Z0-9]`
6+
and SHOULD be consistent across subjects.
7+
If numbers are used in session labels we RECOMMEND using zero padding
78
(for example `ses-01`, `ses-11` instead of `ses-1`, `ses-11`). This makes
89
results of alphabetical sorting more intuitive. Acquisition time of session can
9-
be defined in the sessions file (see below for details).
10+
be defined in the [sessions file](#sessions-file).
1011

11-
The extra session layer (at least one `/ses-<label>` subfolder) should
12+
The extra session layer (at least one `/ses-<label>` subfolder) SHOULD
1213
be added for all subjects if at least one subject in the dataset has more than
13-
one session. Skipping the session layer for only some subjects in the dataset is
14-
not allowed. If a `/ses-<label>` subfolder is included as part of the
15-
directory hierarchy, then the same `ses-<label>` tag must also be
14+
one session.
15+
If a `/ses-<label>` subfolder is included as part of the directory hierarchy,
16+
then the same [`ses-<label>`](./99-appendices/09-entities.md#ses)
17+
key/value pair MUST also be
1618
included as part of the file names themselves.
1719

1820
```Text
@@ -71,11 +73,11 @@ sub-<label>/
7173
Optional: Yes
7274

7375
In case of multiple sessions there is an option of adding additional
74-
participant key files describing variables changing between sessions. In such
75-
case one file per participant should be added. These files need to include
76-
compulsory `session_id` column and describe each session by one and only one
77-
row. Column names in per participant key files have to be different from group
78-
level participant key column names.
76+
`sessions.tsv` files describing variables changing between sessions.
77+
In such case one file per participant SHOULD be added.
78+
These files MUST include a `session_id` column and describe each session by one and only one row.
79+
Column names in `sessions.tsv` files MUST be different from group level participant key column names in the
80+
[`participants.tsv` file](./03-modality-agnostic-files.md#participants-file).
7981

8082
`_sessions.tsv` example:
8183

0 commit comments

Comments
 (0)