Skip to content

Commit d98df88

Browse files
committed
[DATALAD RUNCMD] Rename <pipeline_name> into <pipeline-name> for uniformity
=== Do not change lines below === { "chain": [], "cmd": "git-sedi pipeline_name pipeline-name", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^
1 parent 27c7e83 commit d98df88

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

src/common-principles.md

Lines changed: 2 additions & 2 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_name>-<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_name>[-<variant>]` 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

src/derivatives/common-data-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ A guide for using macros can be found at
178178
Template:
179179

180180
```Text
181-
<pipeline_name>/
181+
<pipeline-name>/
182182
sub-<label>/
183183
[ses-<label>/]
184184
<datatype>/

src/derivatives/imaging.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ extent and resolution.
88
Template:
99

1010
```Text
11-
<pipeline_name>/
11+
<pipeline-name>/
1212
sub-<label>/
1313
[ses-<label>/]
1414
<datatype>/
@@ -146,7 +146,7 @@ And the corresponding `sub-001_task-rest_run-1_space-fsLR_bold.json` file:
146146
Template:
147147

148148
```Text
149-
<pipeline_name>/
149+
<pipeline-name>/
150150
sub-<label>/
151151
[ses-<label>/]
152152
anat|func|dwi/
@@ -265,7 +265,7 @@ of how integer values map to anatomical structures.
265265
Template:
266266

267267
```Text
268-
<pipeline_name>/
268+
<pipeline-name>/
269269
sub-<label>/
270270
[ses-<label>/]
271271
anat|func|dwi/
@@ -332,7 +332,7 @@ the structure.
332332
Template:
333333

334334
```Text
335-
<pipeline_name>/
335+
<pipeline-name>/
336336
sub-<label>/
337337
[ses-<label>/]
338338
func|anat|dwi/
@@ -408,7 +408,7 @@ CIFTI-2 dense label files, with the extension `.dlabel.nii`.
408408
Template:
409409

410410
```Text
411-
<pipeline_name>/
411+
<pipeline-name>/
412412
sub-<label>/
413413
[ses-<label>/]
414414
anat/

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Example:
111111

112112
As for any BIDS dataset, a `dataset_description.json` file MUST be found at the
113113
top level of every derived dataset:
114-
`<dataset>/derivatives/<pipeline_name>/dataset_description.json`.
114+
`<dataset>/derivatives/<pipeline-name>/dataset_description.json`.
115115

116116
In contrast to raw BIDS datasets, derived BIDS datasets MUST include a
117117
`GeneratedBy` key:
@@ -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_name>[-<variant>]/`, the first
134-
`GeneratedBy` object should have a `Name` of `<pipeline_name>`.
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)