IQSS / IQSS/dataverse

In DataCite/Datacite and OpenAIRE/oai_datacite exports, determine "Issued" `dateType` by following same logic used for determining `publicationYear`

Open
#12,361 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

GREI 2 GREI 3 GREI 4 Size: 3
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

Tell Dataverse to determine the date used in the DataCite/Datacite and OpenAIRE/oai_datacite exports' "Issued" dateType by following same the same logic that's used for determining the publicationYear

What kind of user is the feature intended for?
API User, Superuser, and Sysadmin

What inspired the request?
Following a review of part of the NIH GREI Metadata Recommendations (#470), we've found that we should tell Dataverse that for determining the date used in the DataCite/Datacite and OpenAIRE/oai_datacite exports' "Issued" dateType, it should follow the same logic that it already uses for determining the publicationYear.

What existing behavior do you want changed?

Currently, when the user enters a date in the Distribution Date field, Dataverse adds that date in the DataCite/Datacite and OpenAIRE/oai_datacite exports and sends it to DataCite as:

<date 
   dateType="Issued">YYYY-MM-DD
</date>

Instead, the date in dateType="Issued" should be determined using the same logic that Dataverse already uses for determining what year to add in the publicationYear property, except of course it should include the month, day and year when possible.

  • Dataverse uses the year that the user chose as the "citation date", when they used the API endpoint "Set Citation Date Field Type for a Dataset"
  • If the user hasn't changed the dataset's citation date using that API endpoint, then the DataCite export uses the latest of:
    • the Publication Date, when the dataset's first version was published in the Dataverse repository or
    • the embargo citation date, being the latest date of embargoed files on the dataset's first version
  • If the latest dataset version is a draft and the user hasn't set any embargo dates for files in the dataset, the DataCite export uses the date when the user last updated the draft version

Any open or closed issues related to this feature request?

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

Locate the DataCite/Datacite and OpenAIRE/oai_datacite export entry points and the existing publicationYear calculation. Trace the Set Citation Date Field Type API and its date-selection rules, then align the Issued date behavior with them, including month and day where available. Verify the exports for citation dates, publication dates, embargoes, and draft updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
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.