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] clarify MEG empty-room recording naming conventions #480

Merged
merged 11 commits into from
Jun 22, 2020

Conversation

sappelhoff
Copy link
Member

@sappelhoff sappelhoff commented May 23, 2020

this section was unclear, see mne-tools/mne-bids#421 (comment)

This PR aims at improving / clarifying the used language and examples.


I am wondering, why noise as a task name and date as a session label have only "SHOULD", and not "MUST" definitions 🤔 anyone got a clue?

@hoechenberger
Copy link
Collaborator

I am wondering, why noise as a task name and date as a session label have only "SHOULD"

Maybe to allow omitting them entirely? And the intention was not to allow arbitrary values?

@jasmainak
Copy link
Collaborator

Maybe to allow omitting them entirely? And the intention was not to allow arbitrary values?

But they cannot be ommitted. Task label is a required label.

@jasmainak
Copy link
Collaborator

why noise as a task name and date as a session label have only "SHOULD", and not "MUST" definitions 🤔 anyone got a clue?

If you ask me, SHOULD is pretty much OPTIONAL because validator does not check for it :) 30% of the spec is checked in the validator.

@hoechenberger
Copy link
Collaborator

But they cannot be ommitted. Task label is a required label.

Maybe to allow omitting them entirely? And the intention was not to allow arbitrary values?

But they cannot be ommitted. Task label is a required label.

That's true. But session is optional…

Copy link
Collaborator

@hoechenberger hoechenberger left a comment

Choose a reason for hiding this comment

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

I've made a few suggestions, feel free to apply or ignore them :)

Copy link
Collaborator

@hoechenberger hoechenberger left a comment

Choose a reason for hiding this comment

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

I made some suggestions regarding phrasing and markup, feel free to apply to ones you like and leave out the others.

@sappelhoff
Copy link
Member Author

thanks @hoechenberger :)

@sappelhoff sappelhoff added this to the 1.3.1 milestone Jun 2, 2020
@sappelhoff
Copy link
Member Author

Thanks for your reviews @jasmainak @robertoostenveld and @hoechenberger

before I merge I just want to make sure you all saw the final version and approve of it.

Copy link
Collaborator

@hoechenberger hoechenberger left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Collaborator

@robertoostenveld robertoostenveld left a comment

Choose a reason for hiding this comment

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

looks good, thanks!

@jasmainak
Copy link
Collaborator

sorry for the last minute comments! 🙈

@sappelhoff sappelhoff modified the milestones: 1.4.0, 1.4.1 Jun 7, 2020
@sappelhoff
Copy link
Member Author

@robertoostenveld @jasmainak we got an answer on MRI phantoms: #480 (comment)

Also, I voiced my opinion here: #480 (comment)

would be cool if you could take a minute to respond, so that we can move forward with this PR.

@robertoostenveld
Copy link
Collaborator

I am happy with the modifications as proposed in this PR, as they align with what I recall from the in-person discussions we had about this in the preparation of BIDS-MEG. But I would also be fine to leave out the 2nd strategy (task-noise), as long as the 1st strategy (coding it as sub-emptyroom) does not become REQUIRED and remains RECOMMENDED. I don't think it is required that the 2nd strategy is actually explicitly documented; it is something that researchers can do anyway given the current specification. As such the original text that is now still online here is also fine with me.

Furthermore, I think that clarifications to the specification are possibly not always the best discussed as changes to the specification text. We have other channels (google group, neurostars, BIDS starterkit, brainhack mattermost) that I think are more appropriate for clarification questions, for documenting recommendations and use-cases, and for discussion things like those happening now here.

@sappelhoff
Copy link
Member Author

Okay, I'll then strip down the proposed changes heavily so that the way emptyroom is currently described in the spec will essentially remain as is.

I'll take the other things we talked about (re: emptyroom) to a page in the starter kit

Thanks for your reviews all, I'll ping once more when I finished what I just said I'll do.

@sappelhoff
Copy link
Member Author

I rewrote the changes and I think they are now mergeable.

I am not introducing any new notions (anymore), but merely:

  • RECOMMEND the strategy, which so far was "just there" (not recommended or anything)
  • reorder the text to make more sense (folder name, task, session, ... in order)
  • capitalize should -> SHOULD
  • adding explanatory sentences
  • completing the example to also include the metadata, which was previously missing

@sappelhoff sappelhoff changed the title [FIX] clarify empty-room recording naming conventions [FIX] clarify MEG empty-room recording naming conventions Jun 18, 2020
@jasmainak
Copy link
Collaborator

this looks good to me. So now you are essentially just adding clarifying language to directly address @hoechenberger 's issue without mixing it with other issues. If there are new use cases (= data or code) that suggest another strategy is needed to store empty room files (as explained by @robertoostenveld ), I'd be happy to discuss this in a separate issue!

@sappelhoff
Copy link
Member Author

Thanks for the discussion and reviews everybody. The section is a tiny bit better (more understandable and consistent) now :-)

@sappelhoff sappelhoff merged commit 1ca6f40 into bids-standard:master Jun 22, 2020
@sappelhoff sappelhoff deleted the clarifyemptyroom branch June 22, 2020 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants