Versioning: allow citation version display to include date value associated with the version release

[sbarbosadataverse]

IFPRI would like to see the version value in citation show the date (year in this case) of the latest version release (V#, year).

[jggautier]

Harvard Business School made the same request, using this dataset as an example. The latest published major version, 6, was published in 2017, which they wanted to see in the dataset citation for version 6, instead of 2016, which is the year that the first version was published. See this RT for more context.

This is related to #2297

[kuriwaki]

I'd like to make the same request, e.g. using this dataset. The first version was published in 2018, but I'd like to have the citation year be the year the year of the latest version.

[pdurbin]

@kuriwaki as a workaround you can set the citation date to a field that has the date you want: http://guides.dataverse.org/en/5.0/api/native-api.html#set-citation-date-field-type-for-a-dataset

[kuriwaki]

Just realized @jggautier also sent me a shell script to do that -- which did the trick.

Sample for Harvard server. (replace ENTERAPIKEYHERE and ENTERDOIHERE):
curl -H "X-Dataverse-key: ENTERAPIKEYHERE" -X PUT https://dataverse.harvard.edu/api/datasets/:persistentId/citationdate?persistentId=doi:ENTERDOIHERE --data "dateOfDeposit"

Thanks to both of you. I think I got the hang of implementing the API in terminal now.

[jggautier]

Just spoke with another depositor requesting that the year in which each version was published be used for that version's recommended citation. For my colleagues at IQSS, see the email thread at https://help.hmdc.harvard.edu/Ticket/Display.html?id=329289.

Since I already found it when looking for more info to help the depositor, it might be helpful to share some meeting notes, and the only documentation I could find, from when the recommended citation was being designed and the team was figuring out what to use for the year: https://docs.google.com/document/d/1n78KX2ByxuN7IBDIl7gQWTgEH3fROKS77-gExTfdhHc.

There's nothing in the notes about how the year should change from one version to the next, but there have been other discussions and requests since, and the creation of the API endpoint discussed earlier in this issue that lets depositors change the year.

[jalperin]

🙋 I think I'm the depositor @jggautier mentioned above. Posting in case anyone needs to follow up directly. In my view, all MAJOR revisions of the dataset should update the citation year. If it is not a good idea to make it automatic, then my suggestion is for the year should be pulled from a metadata field (i.e., the deposit date) which the depositor can choose to update (or leave as-is).

Our use-case is that we have a data that gets updated yearly. Each year's data supersedes the next, but it should be clear when someone is citing in an article what year's data they were referring to. While citing a specific version technically accomplishes this, it would create confusion if the 2022 version of the data was cited as (authors, 2021) in the text and people needed to read the citation to see that it is 2021v2 to understand that the data was from 2022.