Skip to content

Commit 457a5dc

Browse files
committed
[MISC] consolidate BIDS citations in introduction. fixes #525
1 parent 2f0f61b commit 457a5dc

File tree

5 files changed

+90
-54
lines changed

5 files changed

+90
-54
lines changed

src/01-introduction.md

Lines changed: 70 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ standard you will benefit in the following ways:
1919
acquired by a graduate student or postdoc that has already left the lab.
2020

2121
- There are a growing number of data analysis software packages that can
22-
understand data organised according to BIDS (see
23-
[http://bids.neuroimaging.io](http://bids.neuroimaging.io) for the most up
24-
to date list).
22+
understand data organised according to BIDS (see the
23+
[up to date list](https://bids.neuroimaging.io/benefits.html)).
2524

26-
- Databases such as OpenNeuro.org accept datasets organised according to BIDS.
25+
- Databases such as [OpenNeuro.org](https://openneuro.org/) accept datasets
26+
organised according to BIDS.
2727
If you ever plan to share your data publicly (nowadays some journals require
2828
this) you can minimize the additional time and energy spent on publication,
2929
and speed up the curation process by using BIDS to structure and describe
@@ -32,9 +32,12 @@ standard you will benefit in the following ways:
3232
- Validation tools such as the [BIDS Validator](https://github.com/bids-standard/bids-validator)
3333
can check your dataset integrity and help you easily spot missing values.
3434

35-
BIDS is heavily inspired by the format used internally by OpenfMRI.org and has
36-
been supported by the International Neuroinformatics Coordinating Facility and
37-
the Neuroimaging Data Sharing Task Force. While working on BIDS we consulted
35+
BIDS was heavily inspired by the format used internally by the OpenfMRI repository
36+
that is now known as [OpenNeuro.org](https://openneuro.org/),
37+
and has been supported by the International Neuroinformatics Coordinating Facility
38+
([INCF](https://www.incf.org/))
39+
and the INCF Neuroimaging Data Sharing (NIDASH) Task Force.
40+
While working on BIDS we consulted
3841
many neuroscientists to make sure it covers most common experiments, but at the
3942
same time is intuitive and easy to adopt. The specification is intentionally
4043
based on simple file formats and folder structures to reflect current lab
@@ -50,19 +53,67 @@ Proposals (BEPs). For more information about the BEP process, see
5053

5154
## Citing BIDS
5255

53-
When referring to BIDS in context of academic literature please cite:
56+
When referring to BIDS in context of academic literature, please cite one or
57+
more of the publications listed below.
58+
We RECOMMEND that you cite the original publication on BIDS and *additionally*
59+
the publication regarding the datatype you were using
60+
(e.g., EEG, MEG, iEEG, if available).
5461

55-
> Gorgolewski, K.J., Auer, T., Calhoun, V.D., Craddock, R.C., Das, S., Duff,
56-
> E.P., Flandin, G., Ghosh, S.S., Glatard, T., Halchenko, Y.O., Handwerker,
57-
> D.A., Hanke, M., Keator, D., Li, X., Michael, Z., Maumet, C., Nichols, B.N.,
58-
> Nichols, T.E., Pellman, J., Poline, J.-B., Rokem, A., Schaefer, G., Sochat,
59-
> V., Triplett, W., Turner, J.A., Varoquaux, G., Poldrack, R.A., 2016.
60-
> [The brain imaging data structure, a format for organizing and describing outputs of neuroimaging experiments](https://www.nature.com/articles/sdata201644).
61-
> Sci Data 3, 160044.
62+
For example:
6263

63-
as well as other papers describing specific BIDS extensions (see below).
64+
> The data used in the study were organized using the
65+
> Brain Imaging Data Structure (Gorgolewski, K., Auer, T., Calhoun, V. et al., 2016)
66+
> with the extension for EEG data (Pernet, C.R., Appelhoff, S., Gorgolewski, K.J. et al., 2019).
67+
68+
### original publication
69+
70+
- Gorgolewski, K.J., Auer, T., Calhoun, V.D., Craddock, R.C., Das, S., Duff,
71+
E.P., Flandin, G., Ghosh, S.S., Glatard, T., Halchenko, Y.O., Handwerker,
72+
D.A., Hanke, M., Keator, D., Li, X., Michael, Z., Maumet, C., Nichols, B.N.,
73+
Nichols, T.E., Pellman, J., Poline, J.-B., Rokem, A., Schaefer, G., Sochat,
74+
V., Triplett, W., Turner, J.A., Varoquaux, G., Poldrack, R.A. (2016).
75+
**The brain imaging data structure,**
76+
**a format for organizing and describing outputs of neuroimaging experiments**.
77+
Scientific Data, 3 (160044).
78+
[doi:10.1038/sdata.2016.44](https://doi.org/10.1038/sdata.2016.44)
79+
80+
### datatype specific publications
81+
82+
#### EEG
83+
84+
- Pernet, C. R., Appelhoff, S., Gorgolewski, K.J., Flandin, G., Phillips, C.,
85+
Delorme, A., Oostenveld, R. (2019).
86+
**EEG-BIDS, an extension to the brain imaging data structure for electroencephalography**. Scientific data, 6 (103).
87+
[doi:10.1038/s41597-019-0104-8](https://doi.org/10.1038/s41597-019-0104-8)
88+
89+
#### iEEG
90+
91+
- Holdgraf, C., Appelhoff, S., Bickel, S., Bouchard, K., D'Ambrosio, S.,
92+
David, O., Devinsky, O., Dichter, B., Flinker, A., Foster, B. L.,
93+
Gorgolewski, K. J., Groen, I., Groppe, D., Gunduz, A., Hamilton, L.,
94+
Honey, C. J., Jas, M., Knight, R., Lauchaux, J.-P., Lau, J. C.,
95+
Lee-Messer, C., Lundstrom, B. N., Miller, K. J., Ojemann, J. G.,
96+
Oostenveld, R., Petridou, N., Piantoni, G., Pigorini, A., Pouratian, N.,
97+
Ramsey, N. F., Stolk, A., Swann, N. C., Tadel, F., Voytek, B., Wandell, B. A.,
98+
Winawer, J., Whitaker, K., Zehl, L., Hermes, D. (2019).
99+
**iEEG-BIDS, extending the Brain Imaging Data Structure specification to**
100+
**human intracranial electrophysiology**.
101+
Scientific data, 6 (102).
102+
[doi:10.1038/s41597-019-0105-7](https://doi.org/10.1038/s41597-019-0105-7)
103+
104+
#### MEG
105+
106+
- Niso Galan, J.G., Gorgolewski, K.J., Bock, E., Brooks, T.L., Flandin, G.,
107+
Gramfort, A., Henson, R.N., Jas, M., Litvak, V., Moreau, J., Oostenveld, R.,
108+
Schoffelen, J.-M., Tadel, F., Wexler, J., Baillet, S. (2018).
109+
**MEG-BIDS, the brain imaging data structure extended to magnetoencephalography**.
110+
Scientific Data, 5 (180110).
111+
[doi:10.1038/sdata.2018.110](https://doi.org/10.1038/sdata.2018.110)
112+
113+
### Research Resource Identifier (RRID)
64114

65115
BIDS has also a
66-
[Research Resource Identifier (RRID)](https://www.force11.org/group/resource-identification-initiative)
67-
- `RRID:SCR_016124` - which you can also include in your manuscript in addition
68-
to citing the paper.
116+
[Research Resource Identifier (RRID)](https://www.force11.org/group/resource-identification-initiative),
117+
which you can also include in your citations in addition to relevant publications (see above):
118+
119+
- [`RRID:SCR_016124`](https://scicrunch.org/resources/Any/search?q=SCR_016124&l=SCR_016124)

src/04-modality-specific-files/02-magnetoencephalography.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# Magnetoencephalography
22

3-
Support for Magnetoencephalography (MEG) was developed as a [BIDS Extension Proposal](../07-extensions.md#bids-extension-proposals).
4-
Please cite the following paper when referring to this part of the standard in
5-
context of the academic literature:
6-
7-
> Niso Galan, J.G., Gorgolewski, K.J., Bock, E., Brooks, T.L., Flandin, G.,
8-
> Gramfort, A., Henson, R.N., Jas, M., Litvak, V., Moreau, J., Oostenveld, R.,
9-
> Schoffelen, J.-M., Tadel, F., Wexler, J., Baillet, S. (2018). **MEG-BIDS, the
10-
> brain imaging data structure extended to magnetoencephalography**. Scientific
11-
> data, 5. doi: [10.1038/sdata.2018.110](https://doi.org/10.1038/sdata.2018.110)
3+
Support for Magnetoencephalography (MEG) was developed as a
4+
[BIDS Extension Proposal](../07-extensions.md#bids-extension-proposals).
5+
Please see [Citing BIDS](../01-introduction.md#citing-bids)
6+
on how to appropriately credit this extension when referring to it in the
7+
context of the academic literature.
128

139
## MEG recording data
1410

src/04-modality-specific-files/03-electroencephalography.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
# Electroencephalography
22

3-
Support for Electroencephalography (EEG) was developed as a [BIDS Extension Proposal](../07-extensions.md#bids-extension-proposals).
4-
Please cite the following paper when referring to this part of the standard in
5-
context of the academic literature:
6-
7-
> Pernet, C. R., Appelhoff, S., Gorgolewski, K.J., Flandin, G., Phillips, C.,
8-
> Delorme, A., Oostenveld, R. (2019). **EEG-BIDS, an extension to the brain
9-
> imaging data structure for electroencephalography**. Scientific data, 6.
10-
> doi: [10.1038/s41597-019-0104-8](https://doi.org/10.1038/s41597-019-0104-8)
3+
Support for Electroencephalography (EEG) was developed as a
4+
[BIDS Extension Proposal](../07-extensions.md#bids-extension-proposals).
5+
Please see [Citing BIDS](../01-introduction.md#citing-bids)
6+
on how to appropriately credit this extension when referring to it in the
7+
context of the academic literature.
118

129
The following example EEG datasets have been formatted using this specification
1310
and can be used for practical guidance when curating a new dataset.

src/04-modality-specific-files/04-intracranial-electroencephalography.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
11
# Intracranial Electroencephalography
22

3-
Support for Intracranial Electroencephalography (iEEG) was developed as a [BIDS Extension Proposal](../07-extensions.md#bids-extension-proposals).
4-
Please cite the following paper when referring to this part of the standard in
5-
context of the academic literature:
6-
7-
> Holdgraf, C., Appelhoff, S., Bickel, S., Bouchard, K., D'Ambrosio, S.,
8-
> David, O., Devinsky, O., Dichter, B., Flinker, A., Foster, B. L.,
9-
> Gorgolewski, K. J., Groen, I., Groppe, D., Gunduz, A., Hamilton, L.,
10-
> Honey, C. J., Jas, M., Knight, R., Lauchaux, J.-P., Lau, J. C.,
11-
> Lee-Messer, C., Lundstrom, B. N., Miller, K. J., Ojemann, J. G.,
12-
> Oostenveld, R., Petridou, N., Piantoni, G., Pigorini, A., Pouratian, N.,
13-
> Ramsey, N. F., Stolk, A., Swann, N. C., Tadel, F., Voytek, B., Wandell, B. A.,
14-
> Winawer, J., Whitaker, K., Zehl, L., Hermes, D. (2019). **iEEG-BIDS,
15-
> extending the Brain Imaging Data Structure specification to human intracranial
16-
> electrophysiology**. Scientific data, 6. doi: [10.1038/s41597-019-0105-7](https://doi.org/10.1038/s41597-019-0105-7)
3+
Support Intracranial Electroencephalography (iEEG) was developed as a
4+
[BIDS Extension Proposal](../07-extensions.md#bids-extension-proposals).
5+
Please see [Citing BIDS](../01-introduction.md#citing-bids)
6+
on how to appropriately credit this extension when referring to it in the
7+
context of the academic literature.
178

189
## iEEG recording data
1910

src/04-modality-specific-files/08-genetic-descriptor.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Genetic Descriptor
22

3-
Support for genetic descriptors was developed as a [BIDS Extension
4-
Proposal](../07-extensions.md#bids-extension-proposals).
5-
The extension was primarily developed by Cyril Pernet and Clara Moreau with
6-
contributions from Tom Nichols and Jessica Turner.
3+
Support genetic descriptors was developed as a
4+
[BIDS Extension Proposal](../07-extensions.md#bids-extension-proposals).
5+
Please see [Citing BIDS](../01-introduction.md#citing-bids)
6+
on how to appropriately credit this extension when referring to it in the
7+
context of the academic literature.
78

89
Genetic data are typically stored in dedicated repositories,
910
separate from imaging data.

0 commit comments

Comments
 (0)