[ENH] Reorganise modality agnostic files section into multiple pages#2106
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2106 +/- ##
=======================================
Coverage 82.10% 82.10%
=======================================
Files 17 17
Lines 1531 1531
=======================================
Hits 1257 1257
Misses 274 274 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Hi ! |
|
Hi everyone. Is it okay to merge this PR or are there more updates that would be required? As a note, this is only a refactoring of existing info (no new and/or no remove text). Thanks! |
There was a problem hiding this comment.
I am a little uncertain about using "Data descriptions" here, since "Dataset" includes "Data" as well.
Especially since to a degree summaries like participants.tsv are also "dataset level description": although they already were separated from "Dataset description" section, they were not explicitly sectioned under "Data" section.
It seems that what is common among all, but phenotype/, those "Data description" files -- they are directly pertinent to data under sub-* folders. phenotype/, sure thing, also but it is under a separate folder. I wonder if we should
- also move out Phenotypic and assessment data into its own file/sub-section.
- rename "Data description" into "Data summary files" since all those sections are "{entity/concept} files" (
conceptis forscansone) and thussrc/modality-agnostic-files/data-summary-files.md- this would also better align with a potential bids-2 level enhancement of bids-standard/bids-2-devel#65 and bids-standard/bids-2-devel#85 .
|
Hi @yarikoptic thanks for the review, I changed the names of the "Data description" section and added a new one for Phenotypic and assessment data, as you suggested. |
effigies
left a comment
There was a problem hiding this comment.
LGTM, apart from the redirects.
|
Hey @yarikoptic @effigies are we good to merge with your two approvals or should we wait for more input? Sorry just not sure about the process here... Thanks! |
|
I think we can merge. Been over a week since significant changes, just touch-ups since then. |
|
but ideally we are still to add more redirects whenever someone (might be us) brings that mkdocs/mkdocs-redirects#73 over the finish line |


BEP028 BIDS-Prov is going to introduce a lot of contents into the Modality agnostic files section of the BIDS specification.
In order to prepare for these changes, this PR splits the contents of the
src/modality-agnostic-files.mdfile into separate files in asrc/modality-agnostic-files/directory:src/modality-agnostic-files/dataset-description.mdsrc/modality-agnostic-files/data-description.mdsrc/modality-agnostic-files/code.md