Skip to content

Conversation

@pdurbin
Copy link
Member

@pdurbin pdurbin commented Aug 19, 2025

What this PR does / why we need it:

  • Adds "review" as dataset type and publishes resourceTypeGeneral=Other to DataCite for it.
  • Adds custom metadata blocks related to reviews

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

  • Add "review" as a dataset type
  • Test DataCite changes
    • Create a dataset of type "review" and confirm that DataCite shows it at "Other"
  • Test data citation changes
    • ... I'm not sure how to test this. See comment above.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No, but here's a screenshot from https://dev1.dataverse.org/spa/collections showing the facet:

Screenshot 2025-08-27 at 4 51 27 PM

Is there a release notes update needed for this change?:

Included

@coveralls
Copy link

coveralls commented Aug 19, 2025

Coverage Status

coverage: 24.289% (-0.009%) from 24.298%
when pulling d54ae98 on 11747-review-dataset-type
into 954697d on develop.

@github-actions

This comment has been minimized.

Comment on lines +746 to +747
} else if (type.equals(DatasetType.DATASET_TYPE_REVIEW)) {
itemBuilder.type(CSLType.REVIEW);
Copy link
Member Author

@pdurbin pdurbin Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@qqmyers I made this change without testing anything because I wasn't sure how to. Can you please advise? I'd like to add something under "how to test" about it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you can unit test w.r.t. making sure the CSLJson output has the review type if your datasettype is review. Beyond that, the CSL Json is used in front side JavaScript to generate any of thousands of citation formats, but any given format may or may not use CSLType in generating its output. I can't think of any easy way to test that (but that would really be testing the CSL Java and JavaScript libraries - if our code gets the CSLType into the CSL Json output here, things should work).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thanks. Do you know of any format that uses CSLType? Maybe we can test that type by manually inspecting its output?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know. AI says APA for the social sciences and Chicago for history and arts, and MLA for humanities are popular for reviews - hopefully that means they check the type.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I'm still confused. Still not sure how to test this from JSF. I did look at APA and it says [dataset] (not [review] ) like this:

Screenshot 2025-08-21 at 11 28 18 AM

But I'm not sure if I'm looking in the right place.

If you think I should simply back out of this change, I'm ok with that. Less to mention in the release note. 😄

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can get the CSL format itself via api, e.g. curl https://demo.dataverse.org/api/datasets/:persistentId/versions/1.0/citation/CSL?persistentId=doi:10.70122/FK2/GJF7SF - note the native api guide appears to have an error and lists the format as "CSLJson" rather than "CSL".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, at https://dev1.dataverse.org/api/datasets/:persistentId/versions/1.0/citation/CSL?persistentId=doi%3A10.5072/FK2/RMEZNL I'm getting this:

{
    "id": "-GEN-2mqfdnmq0r",
    "type": "dataset",
    "categories": [
    ],
    "author": [
        {
            "family": "Simpson",
            "given": "Homer",
            "isInstitution": false
        }
    ],
    "issued": {
        "date-parts": [
            [
                2025
            ]
        ]
    },
    "DOI": "10.5072/FK2/RMEZNL",
    "publisher": "Root",
    "title": "Review of Darwin's Finches",
    "URL": "http://ec2-44-214-43-137.compute-1.amazonaws.com/citation?persistentId=doi:10.5072/FK2/RMEZNL",
    "version": "V1"
}

(I need to fix my siteUrl, obviously.) 😅

I guess you're saying ideally "type" would be "review" or at least not "dataset" in that output. It makes me wonder what my change did, if anything. 🤔

Also, thanks for the heads up about the typo in the guides.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant to say you've given me an API endpoint to dig into. Thanks!

@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from dc893bc to 7c629a2 Compare August 26, 2025 14:26
@github-actions

This comment has been minimized.

@cmbz cmbz added the Size: 10 A percentage of a sprint. 7 hours. label Aug 27, 2025
@pdurbin pdurbin moved this from In Progress 💻 to Ready for Review ⏩ in IQSS Dataverse Project Aug 27, 2025
@pdurbin pdurbin removed their assignment Aug 27, 2025
@pdurbin pdurbin marked this pull request as ready for review August 27, 2025 19:08
@jggautier jggautier changed the title add "review" dataset type add "review" dataset type and related metadata blocks Aug 27, 2025
@jggautier
Copy link
Contributor

Next Tuesday I'll add to this PR . properties files for the two metadata blocks

@cmbz cmbz added the FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) label Aug 28, 2025
@jggautier
Copy link
Contributor

I put the two properties files for the metadata blocks into this branch's src/main/java/propertyFiles folder

@github-actions

This comment has been minimized.

Once more than one type appears in search results, a facet called "Dataset Type" will appear allowing you to filter down to a certain type.

If your installation is configured to use DataCite as a persistent ID (PID) provider, the appropriate type ("Dataset", "Software", "Workflow") will be sent to DataCite when the dataset is published for those three types.
If your installation is configured to use DataCite as a persistent ID (PID) provider, the appropriate type ("Dataset", "Software", "Workflow", "Review") will be sent to DataCite when the dataset is published for those types.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this say ("Dataset", "Software", "Workflow", "Other")? Review is sent to Datacite as "Other"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, good point. Maybe I'll change this to "certain types" and link to the table I made elsewhere, or something. Thanks! 😅

@cmbz cmbz added the FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) label Sep 14, 2025
@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from ef2f080 to db4c453 Compare September 17, 2025 18:08
@github-actions

This comment has been minimized.

@pdurbin pdurbin moved this from Ready for Review ⏩ to In Progress 💻 in IQSS Dataverse Project Sep 17, 2025
@cmbz cmbz added the FY26 Sprint 7 FY26 Sprint 7 (2025-09-24 - 2025-10-08) label Sep 24, 2025
@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from db4c453 to 44e2c17 Compare September 26, 2025 13:53
@github-actions

This comment has been minimized.

@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from 44e2c17 to e41d0e3 Compare September 30, 2025 20:07
@github-actions

This comment has been minimized.

@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from df97eb9 to 99fcede Compare October 23, 2025 20:51
@github-actions

This comment has been minimized.

@cmbz cmbz added the FY26 Sprint 10 FY26 Sprint 10 (2025-11-05 - 2025-11-19) label Nov 5, 2025
@cmbz cmbz added the FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) label Nov 22, 2025
@cmbz cmbz added the FY26 Sprint 12 FY26 Sprint 12 (2025-12-03 - 2025-12-17) label Dec 3, 2025
@cmbz cmbz added the FY26 Sprint 13 FY26 Sprint 13 (2025-12-17 - 2025-12-31) label Dec 17, 2025
@cmbz cmbz added the FY26 Sprint 14 FY26 Sprint 14 (2025-12-31 - 2026-01-14) label Dec 31, 2025
These will be provided by each installation rather than
shipping with Dataverse.
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@pdurbin pdurbin added this to the 6.10 milestone Jan 9, 2026
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions
Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11747-review-dataset-type
ghcr.io/gdcc/configbaker:11747-review-dataset-type

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

@pdurbin pdurbin moved this from Ready for Review ⏩ to In Progress 💻 in IQSS Dataverse Project Jan 13, 2026
@pdurbin pdurbin self-assigned this Jan 13, 2026
@pdurbin pdurbin added Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) and removed Size: 10 A percentage of a sprint. 7 hours. labels Jan 14, 2026
@cmbz cmbz added the FY26 Sprint 15 FY26 Sprint 15 (2026-01-14 - 2026-01-28) label Jan 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) FY26 Sprint 7 FY26 Sprint 7 (2025-09-24 - 2025-10-08) FY26 Sprint 8 FY26 Sprint 8 (2025-10-08 - 2025-10-22) FY26 Sprint 9 FY26 Sprint 9 (2025-10-22 - 2025-11-05) FY26 Sprint 10 FY26 Sprint 10 (2025-11-05 - 2025-11-19) FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) FY26 Sprint 12 FY26 Sprint 12 (2025-12-03 - 2025-12-17) FY26 Sprint 13 FY26 Sprint 13 (2025-12-17 - 2025-12-31) FY26 Sprint 14 FY26 Sprint 14 (2025-12-31 - 2026-01-14) FY26 Sprint 15 FY26 Sprint 15 (2026-01-14 - 2026-01-28) Project: Trusted Data Size: 30 A percentage of a sprint. 21 hours. (formerly size:33)

Projects

Status: In Progress 💻

Development

Successfully merging this pull request may close these issues.

Design "Item Reviewed" metadata fields Dataset types should have a display name and a description Add "review" scholarly research object

7 participants