Skip to content

Commit 906e579

Browse files
committed
update paragraph on naming
1 parent 4072021 commit 906e579

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

docs/paper/paper.Rmd

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,15 @@ There currently is a python package (pybids, @yarkoni_pybids_2019)
8181
that "includes virtually any functionality that is likely to be of general use
8282
when working with BIDS datasets (i.e., that is not specific to one narrow context)".
8383

84+
<!-- Menton ANCPBIDS -->
85+
8486
There are also several MATLAB toolboxes (EEGlab `REF_NEEDED`, CONN toolbox `REF_NEEDED`)
85-
have some BIDS support, at least to the extend that they can ingest BIDS datasets.
87+
have some BIDS support, at least to the extend that they can ingest
88+
raw and/or derivatives BIDS datasets.
8689

8790
<!-- Resting state tooboxes -->
8891

89-
But there is no common library that, independently of the imaging modality,:
92+
But there is no common library that, independently of the imaging modality:
9093
- can index and query data and metdata BIDS dataset (whether they are raw or derivatives datasets)
9194
- helps easily create filenames that follow a BIDS pattern
9295
- can interact with the BIDS schema
@@ -115,10 +118,11 @@ BIDS-matlab can:
115118
sessions, runs, modalities, metadata... contained within that dataset (`bids.query`).
116119

117120
BIDS-matlab is able to parse files in a BIDS datasets whether they follow the BIDS schema
118-
or not, but as long as they only follow BIDS filenaming conventions (like those
119-
generated by fMRIprep [@esteban_fmriprep_2019]).
121+
or not, but require that they follow typical BIDS filenaming patterns (like those
122+
generated by fMRIprep [@esteban_fmriprep_2019] -
123+
see [next section](#creating-bids-valid-filenames) for more details).
120124

121-
One notable extension was made to the fielname parsing to accomodate filenames
125+
One notable extension was made to this filename parsing rule to accomodate filenames
122126
that include a prefix before the standard BIDS filename
123127
(for example `swuasub-01_task-rest_bold.nii` with the prefix `swua`)
124128
as prefixing is such a common way to deal with derivatives filenames.
@@ -130,22 +134,23 @@ Most files in a BIDS dataset follow a standard naming convention that can be sum
130134
```bash
131135
datatype/sub-subLabel(_entity-label)*_suffix\.ext
132136
```
137+
<!-- test pseudo regex above and add link and example -->
133138

134139
As of this writing, the BIDS specfication supports:
135140

136-
- 12 datatypes (for example: `func`, `anat`, `eeg`)
137-
- 28 different entities (for example: `ses`, `task`, `acq`)
138-
- 103 suffixes (for example: `bold`, `T1w`, `events`)
141+
- 12 datatypes (for example: `func`, `anat`, `eeg`...)
142+
- 28 different entities (for example: `ses`, `task`, `acq`...)
143+
- 103 suffixes (for example: `bold`, `T1w`, `events`...)
139144

140145
BIDS has a strict set of rules regarding:
141146
- which suffix and entities are allowed for each datatype,
142147
- which entities are allowed for raw and derivatives data,
143148
- which entities are required or optional for each datatype and suffix,
144149
- which order entities should appear in a filename.
145150

146-
- create BIDS compatible filenames or folder structures for raw or derivatives
147-
datasets (`bids.File`, `bids.util.mkdir`,
148-
`bids.dataset_description`),
151+
Creating BIDS valid filenames can therefore become a tedious task.
152+
BIDS-matlab `bids.File` class can help by relying on the BIDS schema
153+
to validate filenames upon creation.
149154

150155
## transformers
151156

0 commit comments

Comments
 (0)