Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FIX] number of small corrections to the specification #98

Merged
merged 17 commits into from
Feb 12, 2019
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
9e410cd
include beh as 6th data type in the common description
robertoostenveld Nov 28, 2018
d05efb4
renamed case 2 to example 3
robertoostenveld Nov 28, 2018
cb71013
clarify in the example description that it explains an error. The oth…
robertoostenveld Nov 28, 2018
07d7e73
updated link to bids-validator, cleaned up formatting of links
robertoostenveld Nov 28, 2018
aff27ac
move utf8 requirement more to the start of the paragraph, rather than…
robertoostenveld Nov 28, 2018
885042c
fixed links to other pages, included a table with BEPs that have been…
robertoostenveld Nov 28, 2018
e7d4375
updated contributions
robertoostenveld Nov 28, 2018
5f76c2a
Merge branch 'master' into patch
robertoostenveld Nov 29, 2018
9381b9e
use behaviour consistently instead of behaviour
robertoostenveld Nov 29, 2018
9f987b0
made the erroneous example more clear by it having only one error, no…
robertoostenveld Nov 29, 2018
9136f67
BF: also rename 05-behavioural-experiments.md to match behavioral spe…
yarikoptic Dec 12, 2018
c08c4cc
BF: resolve line width and table column indentation errors/warnings
yarikoptic Dec 12, 2018
ea06fef
updated patch to reflect recent changes in master, merged conflicts i…
robertoostenveld Jan 10, 2019
7d1bb72
I seemed to have missed one conflict in the previous merge. This is a…
robertoostenveld Jan 10, 2019
b1d94d4
prevent "Incorrect list-item indent: add 2 spaces"
robertoostenveld Jan 10, 2019
d3d2949
attempt to fix "Misaligned table fence"
robertoostenveld Jan 10, 2019
cfb3770
Update 01-contributors.md
robertoostenveld Feb 11, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ nav:
- Magnetoencephalography: 04-modality-specific-files/02-magnetoencephalography.md
- Task events: 04-modality-specific-files/03-task-events.md
- Physiological and other continous recordings: 04-modality-specific-files/04-physiological-and-other-continous-recordings.md
- Behavioral experiments (with no MRI): 04-modality-specific-files/05-behavioural-experiments.md
- Behavioral experiments (with no MRI): 04-modality-specific-files/05-behavioral-experiments.md
- Longitudinal and multi-site studies: 05-longitudinal-and-multi-site-studies.md
- Extending the BIDS specification: 06-extensions.md
- Appendix:
Expand Down
2 changes: 1 addition & 1 deletion src/01-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ obtained in neuroimaging experiments. Even two researchers working in the same
lab can opt to arrange their data in a different way. Lack of consensus (or a
standard) leads to misunderstandings and time wasted on rearranging data or
rewriting scripts expecting certain structure. Here we describe a simple and
easy-to-adopt way of organising neuroimaging and behavioural data. By using this
easy-to-adopt way of organising neuroimaging and behavioral data. By using this
standard you will benefit in the following ways:

- It will be easy for another researcher to work on your data. To understand
Expand Down
41 changes: 19 additions & 22 deletions src/02-common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ interpreted as described in [[RFC2119](https://www.ietf.org/rfc/rfc2119.txt)].
Throughout this protocol we use a list of terms. To avoid misunderstanding we
clarify them here.

1. Dataset - a set of neuroimaging and behavioural data acquired for a purpose
1. Dataset - a set of neuroimaging and behavioral data acquired for a purpose
of a particular study. A dataset consists of data acquired from one or more
subjects, possibly from multiple sessions.

1. Subject - a person or animal participating in the study.

1. Session - a logical grouping of neuroimaging and behavioural data consistent
1. Session - a logical grouping of neuroimaging and behavioral data consistent
across subjects. Session can (but doesn't have to) be synonymous to a visit
in a longitudinal study. In general, subjects will stay in the scanner
during one session. However, for example, if a subject has to leave the
Expand All @@ -33,17 +33,17 @@ clarify them here.
scanning sequence/protocol.

1. Data type - a functional group of different types of data. In BIDS we define
five data types: func (task based and resting state functional MRI), dwi
six data types: func (task based and resting state functional MRI), dwi
(diffusion weighted imaging), fmap (field inhomogeneity mapping data such as
field maps), anat (structural imaging such as T1, T2, etc.), meg
(magnetoencephalography).
(magnetoencephalography), beh (behavioral).

1. Task - a set of structured activities performed by the participant. Tasks
are usually accompanied by stimuli and responses, and can greatly vary in
complexity. For the purpose of this protocol we consider the so-called
“resting state” a task. In the context of brain scanning, a task is always
tied to one data acquisition. Therefore, even if during one acquisition the
subject performed multiple conceptually different behaviours (with different
subject performed multiple conceptually different behaviors (with different
sets of instructions) they will be considered one (combined) task.

1. Event - a stimulus or subject response recorded during a task. Each event
Expand Down Expand Up @@ -128,13 +128,13 @@ participant can exist only at participant level directory, i.e
specific to a participant is to be declared only at top level of dataset for eg:
`task-sist_bold.json` must be placed under `/dataset/task-sist_bold.json`

Example 1: Two JSON files at same level that are applicable for NIfTI file.
Example 1: Two JSON files that are erroneously at the same level.
robertoostenveld marked this conversation as resolved.
Show resolved Hide resolved

```Text
sub-01/
ses-test/
sub-test_task-overtverbgeneration_bold.json
sub-test_task-overtverbgeneration_run-2_bold.json
sub-01_ses-test_task-overtverbgeneration_bold.json
sub-01_ses-test_task-overtverbgeneration_run-2_bold.json
anat/
sub-01_ses-test_T1w.nii.gz
func/
Expand All @@ -146,8 +146,8 @@ In the above example, two JSON files are listed under `sub-01/ses-test/`, which
are each applicable to
`sub-01_ses-test_task-overtverbgeneration_run-2_bold.nii.gz`, violating the
constraint that no more than one file may be defined at a given level of the
directory structure. Instead `task-overtverbgeneration_run-2_bold.json` should
have been under `sub-01/ses-test/func/`.
directory structure. Instead `sub-01_ses-test_task-overtverbgeneration_run-2_bold.json`
should have been under `sub-01/ses-test/func/`.

Example 2: Multiple run and rec with same acquisition (acq) parameters acq-test1

Expand All @@ -168,7 +168,7 @@ apply to different runs and rec files. Also if the JSON file
(`task-xyz_acq-test1_bold.json`) is defined at dataset top level directory, it
will be applicable to all task runs with `test1` acquisition parameter.

Case 2: Multiple json files at different levels for same task and acquisition
Example 3: Multiple json files at different levels for same task and acquisition
parameters

```Text
Expand Down Expand Up @@ -206,12 +206,10 @@ possible. Since the NIfTI standard offers limited support for the various image
acquisition parameters available in DICOM files, we RECOMMEND that users provide
additional meta information extracted from DICOM files in a sidecar JSON file
(with the same filename as the `.nii[.gz]` file, but with a `.json` extension).
Extraction of BIDS compatible metadata can be performed using dcm2nii
[https://www.nitrc.org/projects/dcm2nii/](https://www.nitrc.org/projects/dcm2nii/)
and dicm2nii
[http://www.mathworks.com/matlabcentral/fileexchange/42997-dicom-to-nifti-converter/content/dicm2nii.m](http://www.mathworks.com/matlabcentral/fileexchange/42997-dicom-to-nifti-converter/content/dicm2nii.m)
Extraction of BIDS compatible metadata can be performed using [dcm2nii](https://www.nitrc.org/projects/dcm2nii/)
and [dicm2nii](http://www.mathworks.com/matlabcentral/fileexchange/42997-dicom-to-nifti-converter/content/dicm2nii.m)
DICOM to NIfTI converters. A provided
validator[https://github.com/INCF/bids-validator](https://github.com/INCF/bids-validator)
[validator](https://github.com/bids-standard/bids-validator)
will check for conflicts between the JSON file and the data recorded in the
NIfTI header.

Expand Down Expand Up @@ -275,12 +273,11 @@ Example:
## Key/value files (dictionaries)

JavaScript Object Notation (JSON) files MUST be used for storing key/value
pairs. Extensive documentation of the format can be found here:
[http://json.org/](http://json.org/). Several editors have built-in support for
JSON syntax highlighting that aids manual creation of such files. An online
editor for JSON with built-in validation is available at:
[http://jsoneditoronline.org](http://jsoneditoronline.org). JSON files MUST be
in UTF-8 encoding.
pairs. JSON files MUST be in UTF-8 encoding. Extensive documentation of the
format can be found here: [http://json.org/](http://json.org/). Several editors
have built-in support for JSON syntax highlighting that aids manual creation of
such files. An online editor for JSON with built-in validation is available at:
[http://jsoneditoronline.org](http://jsoneditoronline.org). 

Example:

Expand Down
2 changes: 1 addition & 1 deletion src/03-modality-agnostic-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ decreased. Dates that are shifted for anonymization purposes should be set to a
year 1900 or earlier to clearly distinguish them from unmodified data. Shifting
dates is recommended, but not required.

Additional fields can include external behavioural measures relevant to the
Additional fields can include external behavioral measures relevant to the
scan. For example vigilance questionnaire score administered after a resting
state scan.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Whenever possible, please avoid using ad-hoc wording.
| ManufacturersModelName | RECOMMENDED. Manufacturer’s designation of the MEG scanner model (e.g. `CTF-275`). See [Appendix VII](../99-appendices/07-meg-systems.md) with preferred names |
| SoftwareVersions | RECOMMENDED. Manufacturer’s designation of the acquisition software. |
| TaskDescription | RECOMMENDED. Description of the task. |
| Instructions | RECOMMENDED. Text of the instructions given to participants before the scan. This is not only important for behavioural or cognitive tasks but also in resting state paradigms (e.g. to distinguish between eyes open and eyes closed). |
| Instructions | RECOMMENDED. Text of the instructions given to participants before the scan. This is not only important for behavioral or cognitive tasks but also in resting state paradigms (e.g. to distinguish between eyes open and eyes closed). |
| CogAtlasID | RECOMMENDED. URL of the corresponding [Cognitive Atlas](http://www.cognitiveatlas.org/) term that describes the task (e.g. Resting State with eyes closed "[http://www.cognitiveatlas.org/term/id/trm_54e69c642d89b](http://www.cognitiveatlas.org/term/id/trm_54e69c642d89b)") |
| CogPOID | RECOMMENDED. URL of the corresponding [CogPO](http://www.cogpo.org/) term that describes the task (e.g. Rest "[http://wiki.cogpo.org/index.php?title=Rest](http://wiki.cogpo.org/index.php?title=Rest)") |
| DeviceSerialNumber | RECOMMENDED. The serial number of the equipment that produced the composite instances. A pseudonym can also be used to prevent the equipment from being identifiable, as long as each pseudonym is unique within the dataset. |
Expand Down
14 changes: 9 additions & 5 deletions src/06-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@ There are many ways to get involved with the BIDS community!
If you're new
to the BIDS community and you'd like to learn a bit more, we recommend checking
out the [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit/blob/master/README.md).
This has introductory information about the BIDS specification, tools in the
BIDS ecosystem, and how you can get involved.
This has introductory information about the BIDS specification, tools in
the BIDS ecosystem, and how you can get involved.

### The BIDS Contributor guide

If you'd like to get involved more heavily in helping extend the BIDS
specification or develop tools for it, see the
[BIDS Contributor Guide](https://docs.google.com/document/d/1pWmEEY-1-WuwBPNy5tDAxVJYQ9Een4hZJM06tQZg8X4/edit?usp%3Dsharing&sa=D&ust=1537468908724000).
specification or develop tools for it, see the [BIDS Contributor Guide](https://docs.google.com/document/d/1pWmEEY-1-WuwBPNy5tDAxVJYQ9Een4hZJM06tQZg8X4/edit?usp%3Dsharing&sa=D&ust=1537468908724000).
It contains more in-depth information for getting involved with the BIDS
community.

Expand Down Expand Up @@ -57,7 +56,12 @@ Below is a table of currently-active BEPs.
| [BEP026](https://docs.google.com/document/d/14KC1d5-Lx-7ZSMtwS7pVAAvz-2WR_uoo5FvsNirzqJw) | [Microelectrode Recordings (MER)](https://docs.google.com/document/d/14KC1d5-Lx-7ZSMtwS7pVAAvz-2WR_uoo5FvsNirzqJw) | Greydon Gilmore |

When an extension reaches maturity it is merged into the main body of the
specification.
specification. Below is a table of BEPs that have been merged in the main body
of the specification.

| Extension label | Title | Moderators/leads |
| :---------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------ |
| [BEP008](https://docs.google.com/document/d/1FWex_kSPWVh_f4rKgd5rxJmxlboAPtQlmBc1gyZlRZM) | [Magnetoencephalography (MEG)](https://docs.google.com/document/d/1QwfHyBzOyFWOLO4u_kkojLpUhW0-4_M7Ubafu9Gf4Gg) | Guiomar Niso |

All of the extension ideas that are not backwards compatible and thus
will have to wait for BIDS 2.0 are listed
Expand Down
3 changes: 1 addition & 2 deletions src/99-appendices/01-contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ your name is not listed, please add it.
- Elizabeth DuPre 📖💡🔍🤔
- Eric A. Earl 🤔
- Anders Eklund 📖📢💻
- Oscar Esteban 📖🔧🤔💬💻
robertoostenveld marked this conversation as resolved.
Show resolved Hide resolved
- Franklin W. Feingold 📋📝✅
- Guillaume Flandin 📖💻
- Remi Gau 📖💻
Expand Down Expand Up @@ -87,7 +86,7 @@ your name is not listed, please add it.
- Thomas E. Nichols 📖📢🔧
- Dylan Nielson 📖💻🔧
- Guiomar Niso 📖💡📢
- Robert Oostenveld 📖🔧📢💡
- Robert Oostenveld 📖🔧📢💡✅⚠️🤔
- Patrick Park 📖💡💬
- Dianne Patterson 📖
- John Pellman 📖
Expand Down
4 changes: 2 additions & 2 deletions src/pregh-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ CapManufacturersModelName.
- Remove EEGSamplingFrequency and ManufacturersAmplifierModelName
from the meg.json.

- Improved the behavioural data description.
- Improved the behavioral data description.

## 1.1.0

Expand Down Expand Up @@ -69,7 +69,7 @@ from the meg.json.
- Added trial_type column to the event files.

- Added missing sub-<participant_label> in
behavioural data file names
behavioral data file names

- Added ability to store stimuli files.

Expand Down