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

[GEN-1028] Generate failed annotations report dashboard #546

Merged
merged 4 commits into from
Jan 26, 2024

Conversation

rxu17
Copy link
Contributor

@rxu17 rxu17 commented Jan 13, 2024

Purpose: This is a draft PR. This PR will add a section to our dashboard that showcases the number of failed annotations per center and also let sites know where to find their failed annotations report

Testing:

  • Created R unit tests for some of the dashboard functions
  • Generated the relevant section of the dashboard R markdown file. See current look:
image - Ran the `R/dashboard_markdown_generator.R` using the relevant dashboard code above in docker image

Depends on #545

@rxu17
Copy link
Contributor Author

rxu17 commented Jan 13, 2024

One outstanding question is the historical reason behind not running the dashboard code on the test pipeline? Currently it defaults to running on production:

if not test:
logger.info("DASHBOARD UPDATE")
dashboard_table_updater.run_dashboard(
syn, databaseSynIdMappingDf, genie_version, staging=staging
)
generate_dashboard_html(genie_version, staging=staging)

@thomasyu888
Copy link
Member

One outstanding question is the historical reason behind not running the dashboard code on the test pipeline? Currently it defaults to running on production:

if not test:
logger.info("DASHBOARD UPDATE")
dashboard_table_updater.run_dashboard(
syn, databaseSynIdMappingDf, genie_version, staging=staging
)
generate_dashboard_html(genie_version, staging=staging)

There's not a good reason other than tech debt. If you notice in bin/database_to_staging.py we use test and staging parameters to choose which GENIE project to push data into, however, see this ticket; https://sagebionetworks.jira.com/browse/GEN-420.

Copy link
Member

@thomasyu888 thomasyu888 left a comment

Choose a reason for hiding this comment

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

🦖 LGTM! This is great - have you had a chance to check out quarto at all? I recently created nice looking dashboards like this using purely Python code. It's a game changer.

Note: Not saying we should convert to quarto in this PR. ha

Copy link
Member

Choose a reason for hiding this comment

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

Really appreciate the tests added here.

@rxu17
Copy link
Contributor Author

rxu17 commented Jan 24, 2024

🦖 LGTM! This is great - have you had a chance to check out quarto at all? I recently created nice looking dashboards like this using purely Python code. It's a game changer.

Note: Not saying we should convert to quarto in this PR. ha

Somehow I missed the notifications to the comments in this PR. I have not, this is my first time touching dashboard code here haha but I remember you used it for the hefty data guide PR. Quarto looks great, I am down to just convert to it (plus easier to integrate in tests when it's python and moving away from R dependencies is a plus).

@thomasyu888
Copy link
Member

🦖 LGTM! This is great - have you had a chance to check out quarto at all? I recently created nice looking dashboards like this using purely Python code. It's a game changer.
Note: Not saying we should convert to quarto in this PR. ha

Somehow I missed the notifications to the comments in this PR. I have not, this is my first time touching dashboard code here haha but I remember you used it for the hefty data guide PR. Quarto looks great, I am down to just convert to it (plus easier to integrate in tests when it's python and moving away from R dependencies is a plus).

@rxu17 Lets create a separate ticket to export to quarto, but this is PR is good to go

Copy link

dpulls bot commented Jan 24, 2024

🎉 All dependencies have been resolved !

Base automatically changed from gen-1027-store-error-report to develop January 24, 2024 23:44
@rxu17 rxu17 marked this pull request as ready for review January 26, 2024 00:39
@rxu17 rxu17 requested a review from a team as a code owner January 26, 2024 00:39
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@rxu17 rxu17 merged commit 45e54b3 into develop Jan 26, 2024
8 checks passed
@rxu17 rxu17 deleted the gen-1028-report-dashboard branch January 26, 2024 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants