Skip to content

Commit

Permalink
Merge pull request #264 from effigies/fix/remove_misleading_paragraph
Browse files Browse the repository at this point in the history
[FIX] Clarify paragraph about custom data types
  • Loading branch information
effigies committed Sep 18, 2019
2 parents 3380de8 + d875e95 commit 7030451
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions src/02-common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,6 @@ sub-control01/
sub-control01_phasediff.json
sub-control01_magnitude1.nii.gz
sub-control01_scans.tsv
code/
deface.py
derivatives/
Expand All @@ -440,8 +439,20 @@ dataset_description.json
CHANGES
```

Additional files and folders containing raw data may be added as needed for
special cases. They should be named using all lowercase with a name that
reflects the nature of the scan (e.g., `calibration`). Naming of files within
the directory should follow the same scheme as above (e.g.,
`sub-control01_calibration_Xcalibration.nii.gz`)
## Unspecified data

Additional files and folders containing raw data MAY be added as needed for
special cases.
All non-standard file entities SHOULD conform to BIDS-style naming conventions, including
alphabetic entities and suffixes and alphanumeric labels/indices.
Non-standard suffixes SHOULD reflect the nature of the data, and existing
entities SHOULD be used when appropriate.
For example, an ASSET calibration scan might be named
`sub-01_acq-ASSET_calibration.nii.gz`.

Non-standard files and directories should be named with care.
Future BIDS efforts may standardize new entities and suffixes, changing the
meaning of file names and setting requirements on their contents or metadata.
Validation and parsing tools MAY treat the presence of non-standard files and
directories as an error, so consult the details of these tools for mechanisms
to suppress warnings or provide interpretations of your file names.

0 comments on commit 7030451

Please sign in to comment.