Skip to content

DataCite: integrate openCost (based on v4.7)#159

Closed
aw-bib wants to merge 1 commit intodatacite:masterfrom
opencost-de:oc-67_integrate2datacite
Closed

DataCite: integrate openCost (based on v4.7)#159
aw-bib wants to merge 1 commit intodatacite:masterfrom
opencost-de:oc-67_integrate2datacite

Conversation

@aw-bib
Copy link

@aw-bib aw-bib commented Mar 6, 2026

Purpose

Adding cost data to publications would help to improve transparency about the money spent for publications and allow third parties to analyse the costs of publications. We strongly believe, that payments are part of the metadata of a a publication and are missing in known metadata schemes.

Cost information can be valuable for publishers (to send information to their customers), research institutions (to provide open information about their spending for publishing), and for funders (to collect data about publishing costs).

It seems natural to pass costs along with other metadata during minting of new DOIs in a repository context, be it a repository for primarily text based publications or a repository handling research data, software or other types of objects.

This PR should help to further the discussion started in datacite-suggestions #60 and help to give an idea on how an integration of cost data could look like in code.

Addresses: datacite/datacite-suggestions#60

Approach

  • Add the openCost namespace to the DataCite metadata schema
  • Add the necessary openCost cost types to the schema directory to keep the code self-contained
  • Add an optional metadata block for cost data
  • Add a simple example document that validates against DataCite (as well as stand-alone openCost)

The purpose of this PR is to showcase how embedding of cost data can look like and to help in the necessary discussions ahead.

Open Questions and Pre-Merge TODOs

Learning

openCost is a project funded by the German Research Foundation (DF) via grant 457354095. The above suggestion includes the findings from the first project stage where openCost focused mainly on textual publications like research papers. openCost currently covers publication costs paid as individual fees per article (commonly known as APC) as well as costs paid via larger contracts where publications do not hold individual costs. In the latter case costs are part of the fees paid for the contract.

openCost employs a generic approach to model cost data that is open to extensions and easily extensible. It employs a pretty modular structure and tries to resort to existing standards (e.g. with regard to vocabularies).

openCost developed the integration with the DataCite metadata schema to be able to automatize reporting requirements set by the DFG that are beyond the scope of a data model focused on cost data. To this end openCost proposes to use the DataCite metadata schema enhanced by the openCost data elements as outlined in this PR. openCost strived to keep changes to a bare minimum and abstained from inventing yet another metadata schema to solve the technical questions posed for this specific use case.

Futher details on openCost can be found at

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Reviewer, please remember our guidelines:

  • Be humble in the language and feedback you give, ask don't tell.
  • Consider using positive language as opposed to neutral when offering feedback. This is to avoid the negative bias that can occur with neutral language appearing negative.
  • Offer suggestions on how to improve code e.g. simplification or expanding clarity.
  • Ensure you give reasons for the changes you are proposing.

Add openCost metadata support for publication costs

- Introduce `publicationCostData` element to `metadata.xsd` to support
  openCost metadata
- Add `opencost` namespace import and reference to `datacite:resource`
- Include `opencost_types.xsd` schema for validation:
  The current version can also be fetched from
      https://opencost.de/opencost_types.xsd
  which might make this file obsolete.
- Add example XML with openCost metadata for a journal article
- Define XSD types for openCost data structures including:
  - `data_type` with `publication` and `contract` elements
  - `publication_type` with cost data, identifiers, and institution
  - `contract_type` with contract details and cost data
  - Cost data types with invoice information, amounts paid, and dates
  - Identifier types for primary and secondary identifiers
  - Institution and funding reference structures

Changes are kept to a minimum, the provision of cost data is optional.

Addresses: opencost-de/opencost#67
Addresses: datacite/datacite-suggestions#60
@KellyStathis
Copy link
Contributor

Hi @aw-bib, thanks for sharing your ideas here and on DataCite Suggestions. When a schema change idea is prioritized, this goes through our process including Metadata WG discussions, community review (through an RFC), and implementation by our engineering team. We can certainly consider your design here as part of reviewing the suggestion.

@aw-bib
Copy link
Author

aw-bib commented Mar 11, 2026

Hello @KellyStathis thank you for considering it. I just wanted to share not only a request, but also some more concrete suggestions on how one could approach it. So a PR seemed the most natural thing to do. If we can be of any further help feel free to reach out to us at openCost. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants