Skip to content

Commit bf83ec1

Browse files
authored
Apply suggestion from @julia-pfarr
1 parent fbe869e commit bf83ec1

File tree

1 file changed

+7
-53
lines changed

1 file changed

+7
-53
lines changed

docs/getting_started/folders_and_files/derivatives.md

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -175,62 +175,16 @@ Similarly, BIDS Raw datasets should be interpretable and distributable without
175175
all possible derivatives produced from them.
176176

177177
This independence affords flexibility in the relative organization of datasets.
178-
The following examples show three ways to organize, relative to each other,
179-
a raw BIDS dataset, a preprocessed derivative dataset, and an analysis that uses both as inputs.
178+
The following examples show three ways to organize:
180179

181-
A collection of derivative datasets may be stored in the `derivatives/` subdirectory
182-
of a BIDS (or BIDS Derivatives) dataset:
183-
184-
```bash
185-
my_dataset/
186-
derivatives/
187-
preprocessed/
188-
analysis/
189-
sub-01/
190-
...
191-
dataset_description.json
192-
```
193-
194-
Disadvantage is that such organization would complicate distribution of the raw BIDS dataset
195-
by itself as it would require explicit exclusion of datasets within its `derivatives/` folder.
180+
#### 1. BIDS Raw with derivatives/
196181

197-
A BIDS Derivative dataset may contain references to its input datasets
198-
(could be BIDS Raw, non-BIDS or even other BIDS Derivatives) in the `sourcedata/` subdirectory:
199-
200-
```bash
201-
my_analysis/
202-
sourcedata/
203-
raw/
204-
sub-01/
205-
...
206-
dataset_description.json
207-
preprocessed/
208-
sub-01/
209-
...
182+
A collection of derivative datasets may be stored in the `derivatives/` subdirectory
183+
@@ -199,31 +201,46 @@
184+
analysis/
185+
sub-01/
186+
...
210187
dataset_description.json
211188
```
212189
213-
Note that the `sourcedata/` and `derivatives/` subdirectories constitute dataset boundaries.
214-
Any subfolders of these directories may be validated independently, if they are BIDS datasets
215-
which would be indicated by presence of `dataset_description.json` file(s) in them with a
216-
REQUIRED `"BIDSVersion"` key.
217-
It is important to note that their contents must not affect the interpretation of the nested
218-
or containing datasets.
219-
220-
One potential disadvantage to nesting a BIDS Derivative dataset inside a BIDS Raw dataset, or vice versa,
221-
is that packaging them for independent sharing or publication can become more complicated.
222-
It is also possible to completely avoid nesting of BIDS Raw datasets into BIDS Derivative datasets (or vice versa),
223-
by simply placing them in separate folders, namely `sourcedata/` and `derivatives/` at root level:
224-
225-
```bash
226-
my_study/
227-
sourcedata/
228-
raw/
229-
sub-01/
230-
...
231-
derivatives/
232-
preprocessed/
233-
analysis/
234-
```
235-
236190
<!-- TODO derivatives JSON -->

0 commit comments

Comments
 (0)