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

986 reference papers #1011

Merged
merged 2 commits into from
Oct 17, 2023
Merged

986 reference papers #1011

merged 2 commits into from
Oct 17, 2023

Conversation

dmijatovic
Copy link
Contributor

@dmijatovic dmijatovic commented Oct 10, 2023

Add reference papers to software edit section

Closes #289
Closes #756
Closes #986

Changes proposed in this pull request:

  • The user can add the reference papers used to cite their software.
  • The scraper will search for all citations using OpenAlex api.
  • List all the citations and which reference paper is cited in the "Referenced by" tab

How to test:

  • make start to build app, after app is started you will need to stop it and start it with scrapers. You can use docker compose down && docker compose up -d
  • login as rsd-admin in order to be able to edit existing software, otherwise you can create new software items
  • select first software from the list, and edit the software.
  • rename software to CDK reference test so you can find it easily later,
  • navigate to reference papers section
  • review no items to show messages and provide improvement suggestions (if any)
  • add following CDK reference papers by DOI
  • after you added reference papers you should wait ca. 10 min for scrapers to start working or run manually
docker compose exec scrapers java -cp /usr/myjava/scrapers.jar nl.esciencecenter.rsd.scraper.doi.MainCitations
  • in the meantime navigate to some other pages. When you get back to reference papers page the count in the tab should show the number of citations scraped
  • take another software or create one and try some other reference papers. AFAIK any DOI paper will be scraped for the citations (it does not have to be related to a software at all).

Start screen reference papers page

image

image

Added reference papers

image

Scraper found some citations

image

PR Checklist:

  • Increase version numbers in docker-compose.yml
  • Link to a GitHub issue
  • Update documentation
  • Tests

@ewan-escience ewan-escience force-pushed the 986-reference-papers branch 2 times, most recently from 481cdbb to d181665 Compare October 11, 2023 12:43
@dmijatovic dmijatovic marked this pull request as ready for review October 12, 2023 08:42
@dmijatovic dmijatovic force-pushed the 986-reference-papers branch 3 times, most recently from 036339d to c04fd57 Compare October 12, 2023 11:40
@jmaassen
Copy link
Member

Works well, but I did find a bug:

Papers that have been scraped, and are later added as reference papers in other software do not seem to be scraped themselves. I did the following:

  1. Start and empty RSD with scrapers:
make start 
docker compose down --volumes
docker compose up --scale data-generation=0 --scale scrapers=1 --detach

Next, sign in and create a software called "test". Add the following reference paper:

https://doi.org/10.5194/gmd-10-3167-2017

Then run the scraper using

docker compose exec scrapers java -cp /usr/myjava/scrapers.jar nl.esciencecenter.rsd.scraper.doi.MainCitations

The software should now have 11 "referenced by" papers

  1. Next, clean up the RSD and start over:
docker compose down --volumes
docker compose up --scale data-generation=0 --scale scrapers=1 --detach

Sign in and create a software called "test1". Add the following reference paper:

https://doi.org/10.5194/gmd-7-267-2014

Then run the scraper using

docker compose exec scrapers java -cp /usr/myjava/scrapers.jar nl.esciencecenter.rsd.scraper.doi.MainCitations

The software should now have 14 "referenced by" papers. Note that this includes the paper we used in step 1

Next, create a software called "test2" and add this first reference paper again:

https://doi.org/10.5194/gmd-10-3167-2017

When adding, this paper shows "OpenAlex" as source.

Run the scrapers again (and again). Regardless of how many times I run the scraper, the "referenced by" count for "test2" remains zero.

@ewan-escience ewan-escience force-pushed the 986-reference-papers branch 2 times, most recently from 9ff7827 to fc931f1 Compare October 13, 2023 15:26
@sonarcloud
Copy link

sonarcloud bot commented Oct 13, 2023

[rsd-database] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@sonarcloud
Copy link

sonarcloud bot commented Oct 13, 2023

[scrapers] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 7 Code Smells

0.0% 0.0% Coverage
0.0% 0.0% Duplication

@sonarcloud
Copy link

sonarcloud bot commented Oct 13, 2023

[rsd-frontend] SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 6 Code Smells

4.0% 4.0% Coverage
10.0% 10.0% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

Copy link
Member

@jmaassen jmaassen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works fine with the new fixes

@dmijatovic dmijatovic merged commit 94940a9 into main Oct 17, 2023
8 of 9 checks passed
@ewan-escience ewan-escience deleted the 986-reference-papers branch October 31, 2023 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants