-
Notifications
You must be signed in to change notification settings - Fork 165
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] restructure and clarify *_physio/*_stim section #513
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: I should perhaps change the examples / templates from MRI centric to BIDS:
sub-<label>/[ses-<label>/]
- func/
+ [func/ or meg/ or eeg/ or ieeg/ or beh/]
<matches>[_recording-<label>]_physio.tsv.gz
does somebody have a prettier idea to get this point across?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: I should perhaps change the examples / templates from MRI centric to BIDS:
sub-<label>/[ses-<label>/] - func/ + [func/ or meg/ or eeg/ or ieeg/ or beh/] <matches>[_recording-<label>]_physio.tsv.gzdoes somebody have a prettier idea to get this point across?
In derivatives, we've used <datatype>/
to as a general stand-in data type. If you want to be specific, you could go for <func|meg|eeg|ieeg|beh>/
. I can't immediately find an example where we've done that, but I think it would be clear.
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
"cardiac": { | ||
"Units": "mV" | ||
} | ||
} | ||
``` | ||
|
||
## Additional rules |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it necessary to have a header here? If so, let's think of a more descriptive name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it helps. Everything prior to this header contains the "essential rules" ... everything below contains some half-complete recommendations on specific use cases.
Hence, how about Recommendations for specific use cases
?
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
"cardiac": { | ||
"Units": "mV" | ||
} | ||
} | ||
``` | ||
|
||
## Additional rules |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it helps. Everything prior to this header contains the "essential rules" ... everything below contains some half-complete recommendations on specific use cases.
Hence, how about Recommendations for specific use cases
?
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
I like |
src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I consider this a good clarification of the specification.
There are a few more features/characteristics that would be good to consider (e.g. synchronization with the other data, whether it should be present in the scans.tsv file) but those fall out of scope for this improvement.
…inuous-recordings.md
Today I needed to save some
*_physio
files for the first time and went through the BIDS specification on that topic in detail.I think the section is currently quite disorganized and not formatted consistently with other BIDS sections.
I took a pass and performed:
The diff is quite large but I did not introduce new notions or change old ones (at least not to the best of my knowledge).
Please let me know if you agree that this PR improves the section ... or/and help me to make it (even) better.