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

Merge Bep010 ieeg examples onto master #151

Merged
merged 80 commits into from
Mar 25, 2019
Merged

Merge Bep010 ieeg examples onto master #151

merged 80 commits into from
Mar 25, 2019

Conversation

sappelhoff
Copy link
Member

closes #131
Apart from rebasing on master, this PR brings two changes:

  1. bump up travis version: 49cc200
  2. zero out two large datafiles in ieeg_visual: cfac0a4

Dora and others added 30 commits March 11, 2019 09:47
… file, removed _electrodes.txt and renamed _electrodes.json to _coordframe.json
…ified in the json metadata that accompanies the IntendedFor file
…in the same session as the iEEG (unless the iEEG was recorded with the patient in the MR scanner)
Copy link
Contributor

@chrisgorgo chrisgorgo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@sappelhoff
Copy link
Member Author

this is relevant to: https://github.com/bids-standard/bids-validator/issues/749

I'd like to merge these examples soon and then make a release of the bids-examples to be tested with the bids-validator.

One more approving review from @dorahermes or @choldgraf should do the trick :-)

Copy link
Member

@dorahermes dorahermes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of small suggestions for the epilepsy dataset and I found a small error in one of my datasets for the electrode size. I will make a pull request to fix my dataset.

@sappelhoff
Copy link
Member Author

@dorahermes do you approve of merging this PR now?

@sappelhoff sappelhoff requested a review from dorahermes March 15, 2019 09:32
@dorahermes
Copy link
Member

The only comment left is that the electrode names in the ieeg_epilepsy dataset contain a non-letter/number symbol: '. I cannot fix this according to the data/header, because they have zero bites and I can't read the channel labels. I could just remove the ', or just leave it since the dataset currently passes the validator? @choldgraf

@sappelhoff
Copy link
Member Author

sappelhoff commented Mar 15, 2019

What was the reason to only allow numbers and letters in the first place? We don't have this restriction in EEG, and apparently we missed this inconsistency between EEG and iEEG 😬

@choldgraf
Copy link
Collaborator

arggg - what's the state of the validator? I'm guessing it'll pass both of them even if there's a symbol in the channel names, is that right?

@sappelhoff
Copy link
Member Author

I'm guessing it'll pass both of them even if there's a symbol in the channel names, is that right?

yes, that's right :-)

why do you think that symbols in the channel name are a bad idea?

@dorahermes
Copy link
Member

The initial thought was that it would be more difficult to match electrode names and channels labels in case of symbols.

@sappelhoff
Copy link
Member Author

The initial thought was that it would be more difficult to match electrode names and channels labels in case of symbols.

Do you have an example where it would be more difficult? Just so that I can understand better?

To move further, I see these options:

  1. we change the spec to also allow symbols ... this would not be backward compatibility breaking
  2. we enforce to not allow symbols. This would mean:
    • asking @ftadel to adjust his dataset so that channel/electrode names do not contain symbols
    • implementing a check in the validator that prevents symbols in channel/electrode names

@choldgraf
Copy link
Collaborator

if symbols can be in both the channels and in the electrodes names, then I'd be +1 on supporting them since those symbols would be "just another character in a string".

e.g., If channels and electrodes were named ch-01 I could see that being easier to parse then ch01

@choldgraf
Copy link
Collaborator

(but, this would require a change to the spec, as @sappelhoff says...so to me the question breaks into "do we change the spec, or do we change the validator")

@sappelhoff
Copy link
Member Author

sappelhoff commented Mar 17, 2019

+1 for adding to the spec that symbols are also permissible as this would also increase consistency with EEG and I don't see a convincing reason to not include symbols

@dorahermes
Copy link
Member

+1 for adding to the spec that symbols are also permissible for the same reasons

@ftadel
Copy link
Contributor

ftadel commented Mar 18, 2019

+1 for allowing symbols
Many epilepsy centers use a prime (') to indicate whether an electrode is implanted in the left or the right hemisphere (eg. leading to channels A01..A12 and A'01..A'12). Not allowing the single quotes and some other variations (commas, dots, ...) would make the formatting into BIDS more complicated.

@sappelhoff
Copy link
Member Author

alright! see bids-standard/bids-specification#182 ... please review :-)

@sappelhoff
Copy link
Member Author

just fyi: Unless something happens, I will merge this one once bids-standard/bids-specification#182 is merged

@choldgraf
Copy link
Collaborator

I think @dorahermes should "un-request changes" before we merge, just to respect the community process...

@sappelhoff
Copy link
Member Author

I think @dorahermes should "un-request changes" before we merge, just to respect the community process...

+1

@sappelhoff sappelhoff merged commit e29bcc5 into bids-standard:master Mar 25, 2019
@choldgraf
Copy link
Collaborator

🎉

@sappelhoff sappelhoff deleted the bep010_ieeg branch March 25, 2019 15:48
sappelhoff added a commit that referenced this pull request May 12, 2019
Merge Bep010 ieeg examples onto master

Former-commit-id: e29bcc5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

iEEG examples to add
6 participants