[REQUESTS]: Mock up of Metadata badge in Search results view and Record page view

gtsueng commented 7 months ago

Issue Name

Mock up of Metadata badge in Search results view and Record page view

Issue Description

With the updates to the Metadata tags and the user test results on the Metadata Completeness badge, there is concern that the changes will be too cluttered when displayed in the search results page view. To assuage these concerns, please provide mock ups of how the two changes would look together on the:

Search results page/view
A record page/view

Issue Discussion

This mock up request was raised at the bi-weekly meeting dated 2023.12.12

Request Type

New material (mock up, page, feature, etc.)

Material URL

https://drive.google.com/drive/folders/1HinF7HUllce0p15aNIzmnqwPMlkkVOt_?usp=drive_link

Related WBS task

https://github.com/NIAID-Data-Ecosystem/nde-roadmap/issues/19

For internal use only. Assignee, please select the status of this issue

[ ] Not yet started
[x] In progress
[ ] Blocked
[ ] Will not address

Status Description

No response

Request status check list

[X] The request has been scoped
[x] Some immediate discussion or action on the matter was started, but additional information needed
[x] One or more new GitHub Issues, Pull Requests, or files in Google Drive have been created to address the request
[x] The request is awaiting approval to move to staging
[x] The request is awaiting approval to move to production
[x] The request is awaiting approval for closeout
[x] The request has been addressed and closeout of the issue is approved

gtsueng commented 7 months ago

@sudvenk, @hartwickma, @rshabman, @lisa-mml The requested mock ups can now be found here: https://drive.google.com/drive/folders/1HinF7HUllce0p15aNIzmnqwPMlkkVOt_?usp=drive_link

The mock ups show the following conditions:

A search result page (with or without altmetric badge) with the user-tested metadata badge
A record view page (with or without the altmetric badge) with the user-tested metadata badge
A search result page (with or without the altmetric badge) with a bar version of the metadata badge

Why the option of replacing the altmetric badge?

In our previous experience with the altmetric API, there are a limited number of identifiers which can be used to pull the badge.
- Of those identifiers, only DOI's are expected to be useful for the dataset records. The other identifiers are for related publications (PMIDs) or Clinical Trial records (NCTIDs) which would pull the altmetric badge for the publication or clinical trial itself, not the associated dataset.
The number of records with DOIs within the Data Ecosystem is ~347K out of ~2.8 million which are distributed as follows: (Note, if you would like to inspect the distribution of DOIs yourself, you can use the Advanced search option in the portal to search for DOI _exists_.

gtsueng commented 7 months ago

The priority of this issue was raised to high based on an email dated 12/21/2023

Top priorities for updates on the regular call:
o   Search returns incorporating metadata completeness score:  Let’s discuss updates on the Metadata completeness score application queries (#109)
o   Metadata completeness badge: Update on its status, it’s potential to move to staging, etc.  Integrating this score/badge will help us track improvements in Portal dataset metadata quality.
o   Improving quality of existing dataset metadata:  Updates on efforts to improve specific categories (e.g., filling in pathogen, host species, experimental type, etc).  Returns often link to manuscripts or websites which are not datasets DOIs.  These are highlighted in the QA/QC of the WBS.
o   Review of NIAID priority resources that we shared with UCSD

gtsueng commented 6 months ago

The ask:

Do we keep Altmetrics badges when most records will not have them?
Can we move the record view of the metadata completeness badge to staging?
Which card view of the metadata completeness badge, should we move to staging? (bar view, circular badge view)

hartwickma commented 6 months ago

Hi Ginger (@gtsueng) and team, thanks for providing an "ask". We see that this is part of the Agenda/Slides for Tuesday's meeting. Please see our preliminary responses below that we can discuss in more depth during the call next week. Thanks!

Do we keep Altmetrics badges when most records will not have them? • Fine to remove Altmetric badges
Can we move the record view of the metadata completeness badge to staging? • What view is the record view (filenaming is not clear). Please let us know how this is different from the current view? Once this is clear, we’ll quickly review and reply with our decision about staging.
Which card view of the metadata completeness badge, should we move to staging? (bar view, circular badge view) • Move forward with the circular badge

gtsueng commented 6 months ago

Thanks @hartwickma for the response. The record view are the files with 'resource' in the name. It is how a single resource record would look with the metadata completeness badge and the updated metadata tags would look. The 'card' view is how each listing of the record/resource would appear in a list of search results. When you click on one of the listings ('cards') it will take you to a resource/record, displaying the resource/record view.

hartwickma commented 6 months ago

Hi @gtsueng

The files were described above as:

A search result page (with or without altmetric badge) with the user-tested metadata badge
A record view page (with or without the altmetric badge) with the user-tested metadata badge
A search result page (with or without the altmetric badge) with a bar version of the metadata badge

But the filenames do not correspond. NIAID should look at the files named 'card' to respond to item #2 about record views? What change is NIAID asked to respond to for the 'card' files?

gtsueng commented 6 months ago

Hi @hartwickma, apologies for the confusion. To clarify, the metadata badges will show up in two different views/contexts:

The 'card' view is essentially an individual listing for the search result page (i. and iii. A search result page). (The card view is circled in the context of a search result page below)

The 'card' view mock ups show how a badge would look on the search results page.

If you click on any card in the search results page, it would take you to the record for that search result. This is the record or resource view (ii. A record view page). The mockups with 'resource' in the file name illustrate how the badge will look on that page.

We are proposing to move the metadata completeness badges to staging so that it will appear in both the search results listing (for each card) and in the record page (resource)

Here are examples of how each view looks on production: search result view (with 10 cards displayed): https://data.niaid.nih.gov/search?q=naegleria+fowleri A record view of one of the cards: https://data.niaid.nih.gov/resources?id=veupathdb_DS_e57644bc33

Please don't hesitate to let me know if further clarification is needed.

gtsueng commented 6 months ago

Sorry for not thinking to do this sooner. Here's a list of the mock ups as they correspond to the description in this issue:

A search result page (with or without altmetric badge) with the user-tested metadata badge
A record view page (with or without the altmetric badge) with the user-tested metadata badge
A search result page (with or without the altmetric badge) with a bar version of the metadata badge

gtsueng commented 6 months ago

@hartwickma @rshabman @sudvenk @lisa-mml

Per the discussion during our bi-weekly meeting on 2024.01.09, we will move the mock ups to staging. I have changed the status of this to in progress - on staging. @candicecz please move the metadata tags and the circular metadata completeness badge to staging. Please use the version without the altmetric badge.

candicecz commented 6 months ago

The following changes have moved to staging:

[x] Metadata tags (with WCAG 2.1 accessible color scheme) in the search page results
[x] Circular metadata completeness badges in the search page results and in the record view page.
[x] Removal of altmetric badge

gtsueng commented 6 months ago

2024.01.17 - We have moved this item to Staging

@hartwickma @rshabman @lisa-mml @sudavenk The ask: We request approval to move this to production.

hartwickma commented 6 months ago

Thank you, OK to move the metadata completenss badge to production. Please also:

draft a 'news update' on the badge and
propose a legend to describe the badge (note, this can come after production).

This issue has substantial overlap with #109.

gtsueng commented 6 months ago

Thanks @hartwickma @sudavenk @rshabman @lisa-mml

@candicecz will move this from Staging to Production and @EmilyHaag will draft a news update for the metadata completeness badge and metadata tags (icons and labels) update

candicecz commented 6 months ago

The metadata badges are now viewable in production. Thanks!

gtsueng commented 6 months ago

We have updated the status of this issue to Pending close out on 2024.01.18. If there are no objections by 2024.01.25, we will proceed to close this issue.

We will create new issues to address the following comments:

Thank you, OK to move the metadata completenss badge to production. Please also:
1. draft a 'news update' on the badge and

2. propose a legend to describe the badge (note, this can come after production).

hartwickma commented 6 months ago

If there are no technical reasons to delay close out, please close this issue.

gtsueng commented 6 months ago

Understood

NIAID-Data-Ecosystem / nde-portal