[WIP] adding first BEP010 spec #118
Conversation
| @@ -2,6 +2,7 @@ Changelog | |||
|
|
|||
| ## [Unreleased](https://github.com/bids-standard/bids-specification/tree/HEAD) | |||
|
|
|||
| - Updating the specification per BEP010 - Extension for iEEG data | |||
There was a problem hiding this comment.
This file is autogenerated from merged PRs. Please revert changes to it.
| This specification extends the Brain Imaging Data Structure (BIDS) Specification for integration of intracranial electroencephalography (iEEG) data, including both surface recordings (electrocorticography, ECoG), depth recordings, such as stereo EEG (sEEG), and recordings done with deep brain stimulation (DBS) electrodes. Most core principles of the original BIDS-fMRI and BIDS-MEG specifications are inherited by the iEEG specification, though some special considerations and additional fields are noted below. | ||
|
|
||
| Please refer to general BIDS specification document for context and general guidelines (definitions, units, directory structure, missing values, stimulus and event information, etc.).: | ||
| https://docs.google.com/document/d/1HFUkAEE-pB-angVcYe6pf_-fVf4sCpOHKesUvfb8Grc |
There was a problem hiding this comment.
This should be a reference to a markownn file
| Please refer to general BIDS specification document for context and general guidelines (definitions, units, directory structure, missing values, stimulus and event information, etc.).: | ||
| https://docs.google.com/document/d/1HFUkAEE-pB-angVcYe6pf_-fVf4sCpOHKesUvfb8Grc | ||
|
|
||
| The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119]. |
There was a problem hiding this comment.
No need to reiterate this
| > TODO: citation | ||
|
|
||
| ## Preliminary clarifications | ||
| This specification extends the Brain Imaging Data Structure (BIDS) Specification for integration of intracranial electroencephalography (iEEG) data, including both surface recordings (electrocorticography, ECoG), depth recordings, such as stereo EEG (sEEG), and recordings done with deep brain stimulation (DBS) electrodes. Most core principles of the original BIDS-fMRI and BIDS-MEG specifications are inherited by the iEEG specification, though some special considerations and additional fields are noted below. |
There was a problem hiding this comment.
I don't think it's useful to use undefined terms such as fmri-bids, meg-bids etc.
|
I pointed out some obvious sections with redundancy, but there are plenty of others. Especially referring to BIDS-fMRI, BIDS-MRI, BIDS-iEEG is confusing - those should be replaced with links to specific sections of the spec. You should check out #108 and #109 for inspiration. PS I don't quite remember who did the reformatting and merging of MEG. |
Co-Authored-By: sappelhoff <[email protected]>
|
I think I was involved in merging of the MEG spec (although I was not the only one, I think Guio did most work). But that was taking snippets from a google doc and pasting them into another google doc (the main spec), which at that time was not yet so heavily visited and commented upon, so the main spec was a relatively clean document and the MEG changes quite overseeable. I think that in this case we might want to have an intermediate version (which would become 1.1.2) to merge the current draft changes into the main spec. This is under the assumption that these are just formatting changes. And then we make a branch starting from that, which would become version 1.2 (including EEG and iEEG). |
… in the sidecar files. Some specific questions related to actual fields in sidecars are raised in bids-standard#108 (comment)
… tables more consistent
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
…ography.md Co-Authored-By: robertoostenveld <[email protected]>
|
ok I think I've got the PR to your branch ready to go: Let me know how that looks and if I need to change anything up. |
|
(ping @sappelhoff in case you're not receiving notifications about this) |
|
This PR is to be closed, since the remaining work is now part of #108. See also |
This is an attempt at adapting the BEP010 spec for this repository. There are probably a bunch of things to update, but it'd be helpful if I could get some high-level feedback on this one.
For example, I basically just tried to adapt word-for-word the google docs version. However, there's probably some redundant information with the base BIDS spec etc. Feel free to recommend sections to remove, move around, etc. Other than that, let me know what I should do. @chrisfilo do you have thoughts on this? Or can you ping somebody who went through this with the MEG spec?