bids-specification icon indicating copy to clipboard operation
bids-specification copied to clipboard

[ENH] data-type recommendation based on simplicity.

Open neuromechanist opened this issue 5 months ago • 1 comments

Following a discussion in the BIDS maintainer meeting on June 10 on #2108 (defining criteria for data types and modalities), @yarikoptic suggested creating proposals to be considered by the community.

This proposal is compatible with the decisions made so far, and might help lay a path forward.

I formed my response to the issue as a dark PR for better visibility.

Please make suggestion, changes and edits regarding this proposal here. Please keep the general discussion under #2108.

[!Note] The rendered version is available here: https://bids-specification--2135.org.readthedocs.build/en/2135/common-principles.html#data-type-and-modality-selection

neuromechanist avatar Jun 10 '25 15:06 neuromechanist

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.15%. Comparing base (daad867) to head (2f4549e). Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2135      +/-   ##
==========================================
- Coverage   82.19%   82.15%   -0.05%     
==========================================
  Files          17       17              
  Lines        1528     1530       +2     
==========================================
+ Hits         1256     1257       +1     
- Misses        272      273       +1     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Jun 10 '25 15:06 codecov[bot]

I am not sure if I understand @oesteban, the majority of common principles are in the markdown, and they are in fact (at least as how I read them) in the form of a guideline; for example, the Inheritance Principle.

The proposed additions in this PR are quite similar to the rest of the text in common-principles.md. I am not sure why these changes should move the yaml file while, for example, the Inheritance Principle is not there. I think common-principles.yaml has its own use under the schema, and it's not related to this.

neuromechanist avatar Aug 05 '25 19:08 neuromechanist