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

Deposit CODECHECK certificates on SciGen.Report #32

Open
12 tasks
nuest opened this issue Dec 10, 2020 · 0 comments
Open
12 tasks

Deposit CODECHECK certificates on SciGen.Report #32

nuest opened this issue Dec 10, 2020 · 0 comments
Assignees
Labels
development Development of the register

Comments

@nuest
Copy link
Member

nuest commented Dec 10, 2020

I just had a very nice call with @amorim-cjs about how to push new codecheck certificates into the SciGen.Report platform/database. I think it would be great to contibute to SciGen.Report as an inpedendent platform, where users can freely share their post-publication reproduction attempts.

Notes on the process/integration

  • authentication with SciGen.Report API?
    • double layer authentication but so far only for human users: password, and captcha
    • easiest would be a token (manual token fine for now, maybe in the future generate token on user page)
    • add new POST endpoint to access function directly, e.g., POST /codecheck/submit/access_token/ - to be implemented
    • we submit "on behalf of user" > can we use the ORCID to connect the review with the original author?
      • yes, ORCID integration is planned
    • looking at https://github.com/amorim-cjs/scigen-report/blob/hacktoberfest/source/PeerRep.sql#L88 fields for required data
      • paper_id is internal, so we just submit DOI and the platform fetches article metadata from crosreff
      • user_id would be a codecheck user
      • review text can be certificate summary
      • we have no source for the level of the review, see Levels of success for CODECHECK certificates discussion#12 - we could just use a defensive default, or try to derive this from the summary text (looking for keywords, NLP)
      • the review will soon have a new field for links (just a field with a list of links CSV, then add some polish on the UI to separate them and add icons) > we can add the DOI of the report and the code repository as links
  • I'd be happy to implement, but not PHP dev; he thinks not much work on PHP end
  • real site runs as PHP app on AWS
  • how are integration tests done?

Technical prerequisites

  • ORCID is stored in user profile
  • links field for reviews added
  • there is a POST endpoint to add a new review via script
  • token-based authentication works

SciGen.Report is a side project, similar to CODECHECK, so there is no clear timeline for any of these! I might be able to contribute some coding next year.

Implementation steps

  • register a codecheck user on SciGen.Report so we can post reviews on her behalf
  • get local dev version working
    • docker-compose up should be it > almost works!
    • start with hacktoberfest branch
  • implement POST endpoint on the server
  • implement R function to submit required information for a review (maybe with a check to see if it is already there? should be possible to realise that by checking for links to the report, or by checking if the paper already as a review by the codecheck user)
  • use function to manually submit reviews for existing codechecks
  • get token for codecheck user
  • integrate encrypted token into the GH action
  • GH action submits to SciGen.Report if a new certificate is added
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Development of the register
Projects
None yet
Development

No branches or pull requests

1 participant