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.

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

Implement Citations Section #9

Open
mpitblado opened this issue Oct 25, 2023 · 7 comments
Open

Implement Citations Section #9

mpitblado opened this issue Oct 25, 2023 · 7 comments
Assignees
Labels
enhancement New feature or request

Comments

@mpitblado
Copy link
Collaborator

Following the removal of the previous custom citation page in 0ad1918, implement the citation section as shown in the base theme https://hp-theme.gbif-staging.org/literature/search, scoped to literature that references the BBM

@mpitblado mpitblado added the enhancement New feature or request label Oct 25, 2023
@mpitblado mpitblado added this to the 1.0.0 milestone Oct 25, 2023
@mpitblado mpitblado self-assigned this Oct 25, 2023
@MortenHofft
Copy link
Member

I sometimes wonder if this place in particular needs an explanation. What is your impression? And do you have suggestions for how it should look/work?

@mpitblado
Copy link
Collaborator Author

My two cents (all just suggestions)

I asked some of the curators here at the museum what matters most to them in terms of citations, and two main themes came up

Making it easy for users to understand how to properly cite things

One of the big problems that institutions, collections, (and probably GBIF as well) face is that great systems are set up to track when citations are made, however the researcher publishing the paper doesn't properly link the paper to all of the proper systems. This widget (below) has already been developed, and is probably something that could be nicely included in the literature/citations page for an institution.

citation-explanation-widget

There could be a filter box placed (already in place for occurrences, dataset searches etc) above this widget that changes the citation content. This means that visually, the citations widget can exist just once, limiting screen real estate, but be changed depending on what the user would like to cite from within the scope of the portal. Importantly, this scales no matter the size and scope of the portal, all that would need to happen is to have filters set up in _config depending on which options should be made available to the user, and those options are available within the filter.

filter-functionality-example

While these citation widgets already exist on the bottom of dataset pages, they are easy to miss, and there are additional cases in which someone uses the portal to look up something (say, a university student looks up the length of a bird wing for a paper directly on the portal, and doesn't download anything, they should know how to cite the collection they looked that information up in) and credit the collection and GBIF appropriately. Here at the museum, we could then tell instructors/students that this is the one place they have to look whenever they are accessing information through the portal.

Literature, Citations and Metrics

The current table for literature linked to the portal is fantastic, and should be kept, but it doesn't need to take the whole screen (similar to how the gbif citation widget can just take up a smaller space on the screen, but in this case the user can also search more easily). Instead, graphs (such as those that are used in the dashboards for collections/institutions) should have the same functionality for citations over time, the most popular journals that the citations took place in, citations by collection/prep type etc. Graphs convince university/government leadership that the GBIF hosted portal, and the institution it is attached to is working, using a metric that matters to them. There is already a citations aggregate count on the top right of the dataset layout, so it may just be scope changes and then loading that data into graphs. Something akin to the metrics section shown below

image

Overall layout

image

@MortenHofft
Copy link
Member

MortenHofft commented Oct 30, 2023

Thank you for compiling this @mpitblado

Making it easier to cite
I guess this is a balance between making it easy to cite, but also making those citations useful.
I will give this some thought and ask others for ideas.
We currently do not have the option to generate a citation string before a download is triggered. That is the point where we reserve/issue a DOI and store a snapshot of the data for future reference. So there is no citation string before the user asks us to generate one.
Similar for collection citations, the data is dynamic since it is attached from dataset sources, but perhaps we could do something here. Especially if the collection has a 1:1 mapping with a dataset.

For publishers we do something that resembles what you mention with graphs about citations
https://hp-theme.gbif-staging.org/publisher/b542788f-0dc2-4a2b-b652-fceced449591/citations

We could add citations to the dataset citation tab like we do on publishers?

Having a citation widget to generate citations without triggering a download isn't possible I'm afraid. It would be nice though. But it makes sense to at least explain more explicitly what the user need to do to get that citation string.

Thanks

@mpitblado
Copy link
Collaborator Author

@MortenHofft makes sense! Cannot generate the citation until the doi has been reserved.

I would definitely advocate for the citations being added to datasets in the same way they are for publishers, don't see a downside to including the information under the table in the same way! People here would love it, because reporting is often done at the dataset level in addition to the entire institution.

Is there a document/webpage that I could look through that goes over the difference between a publisher/institution? I'm fairly confident I understand the difference between a collection/dataset.

@ManonGros
Copy link

Hi @mpitblado This is a question we got several times now so I attempted writing an FAQ on the GRSciColl website. You can check it here: gbif/hp-grscicoll@2a47efe.
Does this seem sensible to you?

@mpitblado
Copy link
Collaborator Author

Hi @ManonGros yes that makes sense to me, thanks for writing it up! Heads up there is a typo in line 49 of that commit, However, they are some differences: should be However, there are some differences:.

@ManonGros
Copy link

Thanks @mpitblado, I corrected the typo

@mpitblado mpitblado modified the milestones: 1.0.0, 1.1.0 Nov 25, 2023
@mpitblado mpitblado modified the milestones: 1.1.0, 1.2.0 Dec 14, 2023
@mpitblado mpitblado modified the milestones: 1.2.0, 1.3.0 Feb 22, 2024
@mpitblado mpitblado removed this from the 1.3.0 milestone Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants