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

[ENH] Allow datacite.yml in dataset root

Open effigies opened this issue 3 months ago • 1 comments

The DataCite Metadata Schema (https://schema.datacite.org/meta/kernel-4/) is a fairly comprehensive structure for describing citable datasets, including contributors (including organizations and contributor roles), funders, licenses and abstracts.

The DataCite Metadata Working Group publish XSD and Invenio hosts JSON-Schema translations at https://github.com/inveniosoftware/datacite/tree/master/datacite/schemas.

Following the lead of CITATION.cff, we would use YAML, a superset of JSON that is interpreted as a JSON-compatible object.

I would propose that we add the Invenio JSON-Schema documents to the jsr:@bids/schema package, similar to https://jsr.io/@bids/schema/1.1.0/citation/schema.json.

Closes #1955.

TODO:

  • [ ] Add schema checks for MUST/SHOULD statements.
  • [ ] Recommend against having both CITATION.cff and datacite.yml? They could get out-of-sync, but if someone was syncing them, it might make the dataset legible to more tools.

effigies avatar Sep 29 '25 18:09 effigies

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 82.71%. Comparing base (5e8d37f) to head (137c220).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2221   +/-   ##
=======================================
  Coverage   82.71%   82.71%           
=======================================
  Files          20       20           
  Lines        1608     1608           
=======================================
  Hits         1330     1330           
  Misses        278      278           

: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 Sep 29 '25 18:09 codecov[bot]