Skip to content

Commit 27c7e83

Browse files
committed
DOC: make mentioning of pipeline_name consistent
- we really should not advocate having '_' as a separator, so I made example to use 'pipeline1-v1' and 'pipeline2. This should make it much more consistent with how we name in BIDS where '_' is a separator between entities. - we had <pipeline> and <pipeline_name> (as we used in other places). I unified to <pipeline_name> although would not mind going to <pipeline> or introducing (expclitly) that '<pipeline>' means '<pipeline_name>[-<variant>]'
1 parent db1c087 commit 27c7e83

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

src/common-principles.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ Derivatives can be stored/distributed in two ways:
309309
Different components of a pipeline can, however, also be stored under different
310310
subdirectories.
311311
There are few restrictions on the directory names;
312-
it is RECOMMENDED to use the format `<pipeline>-<variant>` in cases where
312+
it is RECOMMENDED to use the format `<pipeline_name>-<variant>` in cases where
313313
it is anticipated that the same pipeline will output more than one variant
314314
(for example, `AFNI-blurring` and `AFNI-noblurring`).
315315
For the sake of consistency, the subdirectory name SHOULD be
@@ -381,7 +381,7 @@ Derivatives can be stored/distributed in two ways:
381381
382382
Throughout this specification, if a section applies particularly to derivatives,
383383
then Case 1 will be assumed for clarity in templates and examples, but removing
384-
`/derivatives/<pipeline>` from the template name will provide the equivalent for
384+
`/derivatives/<pipeline_name>[-<variant>]` from the template name will provide the equivalent for
385385
Case 2.
386386
In both cases, every derivatives dataset is considered a BIDS dataset and must
387387
include a `dataset_description.json` file at the root level (see
@@ -423,8 +423,8 @@ A guide for using macros can be found at
423423
"..." : "",
424424
},
425425
"derivatives": {
426-
"pipeline_1": {},
427-
"pipeline_2": {},
426+
"pipeline1-v1": {},
427+
"pipeline2": {},
428428
"...": "",
429429
},
430430
"dataset_description.json": "",

src/modality-agnostic-files/dataset-description.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ and a guide for using macros can be found at
130130

131131
If a derived dataset is stored as a subdirectory of the raw dataset, then the `Name` field
132132
of the first `GeneratedBy` object MUST be a substring of the derived dataset directory name.
133-
That is, in a directory `<dataset>/derivatives/<pipeline>[-<variant>]/`, the first
134-
`GeneratedBy` object should have a `Name` of `<pipeline>`.
133+
That is, in a directory `<dataset>/derivatives/<pipeline_name>[-<variant>]/`, the first
134+
`GeneratedBy` object should have a `Name` of `<pipeline_name>`.
135135

136136
Example:
137137

0 commit comments

Comments
 (0)