-
Notifications
You must be signed in to change notification settings - Fork 169
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
[ENH] move definition of raw and derivatives datasets to common principles #1815
base: master
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1815 +/- ##
==========================================
+ Coverage 87.92% 88.04% +0.11%
==========================================
Files 16 16
Lines 1375 1380 +5
==========================================
+ Hits 1209 1215 +6
+ Misses 166 165 -1 ☔ View full report in Codecov by Sentry. |
ok but will you keep the intro https://bids-specification.readthedocs.io/en/stable/derivatives/introduction.html with examples or will this go away? |
hum true that the examples look a bit weird without the previous sentence. I will put back that sentence. |
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.
thank you! proposed some wording tune ups
@@ -46,6 +46,9 @@ dataset: | |||
description: | | |||
A set of neuroimaging and behavioral data acquired for a purpose of a particular study. | |||
A dataset consists of data acquired from one or more subjects, possibly from multiple sessions. | |||
derivative: | |||
display_name: derivative dataset | |||
description: If a dataset is derived from at least one other valid BIDS dataset, then it is a derivative dataset. |
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.
why to accent on "valid"? isn't it somewhat assumed since otherwise it is not a BIDS dataset per se?
Also we are talking about BIDS derivative dataset, right?
Also I do not see need for a conditional here.
hence I would suggest
description: If a dataset is derived from at least one other valid BIDS dataset, then it is a derivative dataset. | |
description: A BIDS dataset derived from at least one other BIDS dataset. |
@@ -97,6 +100,9 @@ modality: | |||
the technique is sufficiently uniform to define the modalities `eeg`, `meg` and `ieeg`. | |||
When applicable, the modality is indicated in the **suffix**. | |||
The modality may overlap with, but should not be confused with the **data type**. | |||
raw: | |||
display_name: raw dataset | |||
description: A raw BIDS dataset is data that have been curated into BIDS from a non-BIDS source. |
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.
Looking at other definitions, they are continuation of the phrase "{display_name} is ..." and hence I would adjust here too to
description: A raw BIDS dataset is data that have been curated into BIDS from a non-BIDS source. | |
description: A BIDS dataset that have been curated into BIDS from a non-BIDS source(s), for example data from acquisition hardware. |
Co-authored-by: Yaroslav Halchenko <[email protected]>
derivative: | ||
display_name: derivative dataset |
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.
IMO, derivative and derivative dataset are not identical. If we want to define the generic term "derivative", then it should apply to files and datasets. Similarly with "raw".
TODO