Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Show canonical dataset in MetadataView #2546

Open
wants to merge 14 commits into
base: develop
Choose a base branch
from
Open

Show canonical dataset in MetadataView #2546

wants to merge 14 commits into from
+748 −45

Conversation

robyngit
Copy link
Member

@robyngit robyngit commented Oct 3, 2024 •
edited
Loading

This PR introduces a feature that a visually identifies a dataset as essentially a duplicate of another in the MetadataView. It does this by adding and modifying some components of the view.

New CanonicalDatasetHandlerView

Added a new view, CanonicalDatasetHandlerView that handles identifying and displaying the canonical dataset within a Metadata view.

This new view is a "scoped subview", a self-contained view that is responsible for managing a specific part of UI within a larger parent view. In this case, the CanonicalDatasetHandlerView handles inspecting and modifying specific parts of the already-rendered DOM within the MetadataView. Creating a new view for this purpose avoids adding more complexity to the already very large MetadataView.

The CanonicalDatasetHandlerView is responsible for the following tasks:

  • Inspects the annotations in the MetadataView to identify a canonical dataset.
    • When annotations include both schema.org:sameAs and prov:derivedFrom annotations that have the value, this is assumed to be a reference the DOI of the canonical dataset.
  • Modifies the MetadataView when a canonical dataset is detected, by:
    • Hiding the annotation views that identify the canonical dataset
    • Adding a "info icon" that indicates the dataset is essential a duplicate of another dataset. (An info icon is like the "private" or "archived" icons near the title).
    • Adds a second citation to the citation modal
    • Adds a blue alert box at the top of the page, under the title, that includes the citation to the original dataset
canonical screenshot

New CrossRef model

  • Introduced a new model to handle querying the CrossRef API for metadata about a DOI, including methods for caching responses and clearing the cache.

Changes to other components

Citation Model

  • Added properties for issue and methods to extract volume and issue from the source model. Updated getJournalFromSourceModel and getPidFromSourceModel to handle getting these values from a CrossRefModel.

Citation View

  • Updated the template to include issue and adjust the formatting of the journal, volume, and page information.

Metadata View

  • Deprecated the metadataInfoIcons template in favour of rendering icons directly in the MetadataView methods. This allows us to reuse the logic for adding a "duplicate" icon in the MetadataView along side the private and archived icons.
  • Added checks to avoid re-rendering issue
  • Insert and render the CanonicalDatasetHandlerView

@robyngit robyngit changed the title Add view to show source dataset in MetadataView Show canonical dataset in MetadataView Oct 3, 2024
@robyngit
Add view to show source dataset in MetadataView
94fb5e5 
- Add a new view, CanonicalDatasetHandlerView, to handle identifying and displaying the canonical dataset for a given dataset
- The view removes the annotations that identify the canonical dataset from the metadata view and adds a field to display the canonical dataset url
- The view has shell methods to fill in that will make further modifications to the metadata view

Issue #2541
@robyngit
Move rendering of info icons to MetadataView
6741949 
- Deprecate the template that rendered the icons previously
- Add new methods to MetadataView to render the icons
- Call new methods to render the duplicate icon with the CanonicalDatasetHandlerView

Issue #2541
@robyngit robyngit force-pushed the feature-2541-show-source-dataset branch from 922c13b to 6741949 Compare October 3, 2024 23:12
@robyngit
Fix issues with timing of MetadataView re-render
4e95fa3 
The metadata view re-renders when a users' logged in status changes. Depending on the timing of this change,
re-rendering may occur in the middle of a previous render. This causes elements of the view to break, especially the
new CanonicalDatasetHandlerView. This commit fixes the issue by adding a check to see if the view is already
rendering before re-rendering.

Issue #2541
@robyngit
Ensure that CanonicalData view works on rerender
aa0dd4e 
Issue #2541
@robyngit
Show the source dataset in citation modal
81210d6 
And show the citation modal when the "duplicate" info icon is clicked.

Issue #2541
@robyngit
Add a model for querying CrossRef
b5359d2 
Issue #2541
@robyngit
Allow CrossRef as source dataset for CitationModel
cd22959 
and add rendering of issue & volume for journal articles in the citation APA template

Issue #2541
@robyngit
Fetch citation info for canonical datasets
5c124bd 
using the new CrossRef model

Issue #2541
@robyngit robyngit force-pushed the feature-2541-show-source-dataset branch from 63195fd to 5c124bd Compare October 14, 2024 19:23
@robyngit
Find canonical dataset w/ 2+ sameAs/derivedFrom
06737f1 
Handle datasets that have multiple annotations with the sameAs and/or derivedFrom property.

Issue #2541
@robyngit
Show full citation for canonical dataset
a8c111d 
In Metadata view, show the full citation for the canonical dataset in the "Canonical Dataset" section in the general metadata view.

Issue #2541
@robyngit robyngit linked an issue Oct 14, 2024 that may be closed by this pull request
Prominently indicate when a data package is essentially a duplicate of an external version #2541
Open
@robyngit robyngit marked this pull request as ready for review October 14, 2024 23:02
@robyngit
Copy link
Member Author

robyngit commented Oct 17, 2024 •
edited
Loading

Changes to do based on feedback from @mbjones:

  • Move the canonical citation above the "this version" citation in the citation modal
  • Make the canonical citation on the landing page more prominent, and somewhere near/at the top of the page

@robyngit
Move canon'al dataset to the top of citation modal
270324e 
Canonical dataset citation is now before the "this version" citation in the citation modal on dataset landing pages.

Issue #2541
@robyngit
Copy link
Member Author

robyngit commented Oct 17, 2024 •
edited
Loading

Also fix a problem found in testing:

  • datasets that are private but that the logged in user has authorization to view are sometimes shown as private anyways.

@robyngit
Trigger "renderComplete" on showIsPrivate
ded5b86 
In the MetadataView. This ensures that if the logged in status changes, the view will re-render to show the correct information.

Issue #2541
@robyngit robyngit force-pushed the feature-2541-show-source-dataset branch from 029f128 to ded5b86 Compare October 17, 2024 19:11
@robyngit
Show alert box on duplicate dataset on landing pg
0587969 
Remove the Canonical Dataset field in the General section of dataset landing pages, and instead show a more prominent blue info box at the top of the page with the citation.

Issue #2541
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@rushirajnenuji rushirajnenuji Awaiting requested review from rushirajnenuji

At least 1 approving review is required to merge this pull request.

Assignees

@rushirajnenuji rushirajnenuji

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Prominently indicate when a data package is essentially a duplicate of an external version
2 participants
@robyngit @rushirajnenuji