-
Notifications
You must be signed in to change notification settings - Fork 531
add "review" dataset type and related metadata blocks #11753
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
This comment has been minimized.
This comment has been minimized.
| } else if (type.equals(DatasetType.DATASET_TYPE_REVIEW)) { | ||
| itemBuilder.type(CSLType.REVIEW); |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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".
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
dc893bc to
7c629a2
Compare
This comment has been minimized.
This comment has been minimized.
|
Next Tuesday I'll add to this PR . properties files for the two metadata blocks |
|
I put the two properties files for the metadata blocks into this branch's src/main/java/propertyFiles folder |
This comment has been minimized.
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. |
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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! 😅
ef2f080 to
db4c453
Compare
This comment has been minimized.
This comment has been minimized.
db4c453 to
44e2c17
Compare
This comment has been minimized.
This comment has been minimized.
44e2c17 to
e41d0e3
Compare
This comment has been minimized.
This comment has been minimized.
df97eb9 to
99fcede
Compare
This comment has been minimized.
This comment has been minimized.
These will be provided by each installation rather than shipping with Dataverse.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
📦 Pushed preview images as 🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |

What this PR does / why we need it:
resourceTypeGeneral=Otherto DataCite for it.Which issue(s) this PR closes:
Special notes for your reviewer:
Suggestions on how to test this:
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:
Is there a release notes update needed for this change?:
Included