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

feat(openchallenges): add EDAM terms SQL table and update Challenge.inputDataTypes #2265

Closed
wants to merge 17 commits into from

Conversation

vpchung
Copy link
Member

@vpchung vpchung commented Oct 22, 2023

Changelog

  • add 2 new tables to challenge-service db
    • edam_ontology_term : a table consisting of EDAM ontology terms currently used to annotate challenges in the OC; includes parent classes
    • challenge_input_data_annotation : a table mapping challenges to their EDAM annotation(s)
  • update API spec
  • update Angular API client
  • update Java files
  • automated script that dumps the CSV files has been updated to include the EDAM terms and annotations into the dump

References

Preview

API docs
Screenshot 2024-02-19 at 10 51 16 PM

edam_ontology_term table
Screenshot 2024-02-19 at 8 19 01 PM

challenge_input_data_annotation table
Screenshot 2023-10-22 at 1 31 42 AM

@vpchung vpchung self-assigned this Oct 22, 2023
@vpchung vpchung marked this pull request as ready for review October 24, 2023 22:58
@vpchung vpchung added the sonar-scan-approved-deprecated Ready for Sonar code analysis label Feb 17, 2024
@vpchung
Copy link
Member Author

vpchung commented Feb 17, 2024

2024 update:

  • automated script that dumps the CSV files has been updated to include the EDAM terms and annotations into the dump

@tschaffter
Copy link
Member

@vpchung Please update the information included in the first comment of this PR.

@vpchung vpchung requested a review from tschaffter February 20, 2024 06:52
Copy link

Quality Gate Passed Quality Gate passed for 'openchallenges-app'

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link

Quality Gate Passed Quality Gate passed for 'openchallenges-challenge-service'

Issues
0 New issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
28.3% Duplication on New Code

See analysis details on SonarCloud

Copy link

Quality Gate Passed Quality Gate passed for 'openchallenges-organization-service'

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link

Quality Gate Passed Quality Gate passed for 'openchallenges-image-service'

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Member

Choose a reason for hiding this comment

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

Does the change to this file break the existing stack? Does the web app rely on this object?

The name and description of the object don't seem related. Shall the schema be renamed as EdamAnnotation?

Another question is whether we want to replace the existing data input object by an edam annotation object, or do we augment the existing data input data type object with an EDAM annotation?

Copy link
Member Author

Choose a reason for hiding this comment

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

Does the change to this file break the existing stack? Does the web app rely on this object?

I tested the app, and no breakage was encountered. But it was a superficial test, so perhaps I didn't hit all of the edge cases.

Shall the schema be renamed as EdamAnnotation?

This makes sense to me.

Another question is whether we want to replace the existing data input object by an edam annotation object, or do we augment the existing data input data type object with an EDAM annotation?

I think this depends. Do we see the OC using other ontologies in the future? If so, I'd be inclined to keep it as SimpleChallengeInputData (or ChallengeInputData)

@tschaffter tschaffter changed the title feat(openchallenges): add EDAM ontology terms and challenge annotations feat(openchallenges): add EDAM terms SQL table and update Challenge.inputDataTypes Feb 21, 2024
@tschaffter
Copy link
Member

Replaced by #2557

@tschaffter tschaffter closed this Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sonar-scan-approved-deprecated Ready for Sonar code analysis
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants