dataverse icon indicating copy to clipboard operation
dataverse copied to clipboard

Design "Item Reviewed" metadata fields

Open pdurbin opened this issue 1 month ago • 2 comments

As discussed in yesterday's Trusted Data meeting, we need to design an "Item Reviewed" (working title) metadata field and subfields. (This will be a "compound" field.)

We plan for the field to live in its own metadata block and should come with a name for that too.

I'll try to summarize the discussion below.

Related Dataset

We don't want to use the "Related Dataset" field for a few reasons:

  • Sometimes the review will be of something other than a dataset.
  • There is no structure to the field. It's just a text area.

Here's a screenshot:

Image

Related Publication

We how the Related Publication field has more structure. It looks like this:

Image

Here's the Relation Type dropdown:

Image

One thing we'd like to avoid, if possible, is the poor UX of needing to copy the same information about the DOI into various fields.

Related Datasets (proposed)

We took another look at prototype by @vera of an improved "Related Datasets" field from this repo: https://github.com/vera/related-datasets-cvoc

Here's a screenshot of how it looks:

Image

Unlike "Related Publication", users don't enter the same information over and over.

Questions

  • What should we call the metadata block? Human readable and machine readable name.
  • What should we call the field? "itemReviewed" comes from https://schema.org/CriticReview
  • How best to link to internal datasets and external URLs that may not be datasets and may not even have a PID?
  • When a user reviews an internal dataset, can we avoid data entry that we can look up, such as the title and author of the dataset? Can we store the PID in the database once? Can we avoid having them enter multiple forms of the PID, as they do with Related Publication?

pdurbin avatar Dec 02 '25 19:12 pdurbin

Size 10 for two subfields:

  • URL
  • Citation

pdurbin avatar Dec 03 '25 20:12 pdurbin

Decisions from the 2025-12-08 Trusted Data meeting:

  • Design "Item Reviewed" field and block
    • https://github.com/IQSS/dataverse/issues/12015
    • What should we call the block? Human (Review) and machine readable names (review).
    • Name of parent field: Item Reviewed
      • itemReviewed
      • allowMultiples=true
    • Child fields
      • URL: required
        • Tooltip/description: The URL of the item being reviewed
        • Machine readable name: itemReviewedUrl
      • Type: required
      • Citation: not required
        • Tooltip/description: The full bibliographic citation of the item being reviewed
        • Machine readable name: itemReviewedCitation

pdurbin avatar Dec 15 '25 20:12 pdurbin