IQSS / IQSS/dataverse

Suggestion: add more Funding Information metadata to citation block

Open
#11,977 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Suggestion
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Suggestion

Currently, the citation block contains the following metadata in the "Funding Information" field:

grantNumberAgency Agency The agency that provided financial support for the Dataset Organization XYZ text 49 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE grantNumber citation
grantNumberValue Identifier The grant identifier or contract identifier of the agency that provided financial support for the Dataset text 50 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE grantNumber citation

We would like to propose adding the following fields:

  • grantNumberAgencyIdentifier: Uniquely identifies a funding entity
  • grantNumberAgencyIdentifierScheme: The type of the grantNumberAgencyIdentifier: CrossRef Funder ID, GRID, ISNI, ROR, Other
  • grantNumberTitle: The human readable title or name of the award

These would match the fields funderIdentifier, funderIdentifierType and awardTitle in the FundingReference block defined by DataCite (see https://schema.datacite.org/meta/kernel-4.4/doc/DataCite-MetadataKernel_v4.4.pdf p. 32-33)

What kind of user is the suggestion intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)

  • Depositors or API users submitting funding metadata
  • General users or guests viewing/searching funding metadata

What inspired this idea?

We are currently migrating a repository to Dataverse. The current repository metadata includes this metadata and we would like to store it in Dataverse as well.

What existing behavior do you want changed?

see above

Any brand new behavior do you want to add to Dataverse?

/

Any open or closed issues related to this suggestion?

Didn't find any

Are you thinking about creating a pull request for this issue?
Help is always welcome, is this idea something you or your organization plan to implement?

Yes, we'd be open to contributing a PR for this if there is interest.

cc @johannes-darms @Uparmaksiz @lschruff

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by tracing the citation block's Funding Information metadata and reviewing the linked DataCite Metadata Kernel v4.4 fields; done means the three proposed fields can be submitted, stored, and viewed or searched alongside the existing funding metadata.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.