Skip to content

Commit

Permalink
Merge pull request #183 from Remi-Gau/doc
Browse files Browse the repository at this point in the history
[DOC] fix typo and add detail about entity reordering
Thank you @Remi-Gau for your PR.
  • Loading branch information
arnaudbore authored Sep 26, 2022
2 parents ee60f5d + 1f19c6e commit 94d53b4
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
18 changes: 18 additions & 0 deletions docs/how-to/create-config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,24 @@ specifications][bids-spec].
For a longer example of a Dcm2Bids config json, see
[here](https://github.com/unfmontreal/Dcm2Bids/blob/master/example/config.json).

Note that the different bids labels must come in a very specific order to be bids valid filenames.
If the customLabels fields that are entered that are in the wrong order,
then dcm2bids will reorder them for you.

For example if you entered:

```json
"customLabels": "run-01_task-rest"
```

when running dcm2bids, you will get the following warning:

```bash
WARNING:dcm2bids.structure:✅ Filename was reordered according to BIDS entity table order:
from: sub-ID01_run-01_task-rest_bold
to: sub-ID01_task-rest_run-01_bold
```

## sidecarChanges

Optional field to change or add information in a sidecar.
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -805,8 +805,8 @@ task name:
"modalityLabel": "bold",
"customLabels": "task-rest",
"criteria": {
"SeriesDescription": "Axial EPI-FMRI (Interleaved I to S)*"
"sidecarChanges": {
"SeriesDescription": "Axial EPI-FMRI (Interleaved I to S)*",
"sidecarChanges": {
"TaskName": "rest"
}
}
Expand Down

0 comments on commit 94d53b4

Please sign in to comment.