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

[SCHEMA] Encode requirement levels for dataset_description and genetic_info #1064

Merged

Conversation

effigies
Copy link
Collaborator

Two open questions I see:

  1. How do we want to encode, e.g. NO_AUTHORS, where we effectively promote dataset_description.Authors from OPTIONAL to REQUIRED?
  2. Do we want to specify nested fields, such as Genetics.Database directly? Or have some way of specifying a nested structure as its own object?

@effigies effigies requested a review from tsalo as a code owner April 13, 2022 16:43
@tsalo tsalo added the schema Issues related to the YAML schema representation of the specification. Patch version release. label Apr 13, 2022
@codecov
Copy link

codecov bot commented Apr 13, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.50%. Comparing base (1f6e4d2) to head (5e116de).

Additional details and impacted files
@@              Coverage Diff               @@
##           schema-sprint    #1064   +/-   ##
==============================================
  Coverage          71.50%   71.50%           
==============================================
  Files                  9        9           
  Lines                930      930           
==============================================
  Hits                 665      665           
  Misses               265      265           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tsalo
Copy link
Member

tsalo commented Apr 13, 2022

  1. How do we want to encode, e.g. NO_AUTHORS, where we effectively promote dataset_description.Authors from OPTIONAL to REQUIRED?

I think since NO_AUTHORS is a warning, it would be upgrading from OPTIONAL to RECOMMENDED, right? In any case, what if we had a "publication" level for the validator? The checks in this level wouldn't have to be derived from the specification, but would be necessary for data sharing.

@effigies effigies changed the title SCHEMA: Encode requirement levels for dataset_description and genetic_info [RTM] SCHEMA: Encode requirement levels for dataset_description and genetic_info Apr 15, 2022
@effigies effigies merged commit 713469e into bids-standard:schema-sprint Apr 18, 2022
@effigies effigies deleted the schema/dataset_description branch April 18, 2022 20:17
@sappelhoff sappelhoff changed the title [RTM] SCHEMA: Encode requirement levels for dataset_description and genetic_info [SCHEMA] Encode requirement levels for dataset_description and genetic_info Jul 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
schema Issues related to the YAML schema representation of the specification. Patch version release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants