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

Correctly render benchmark vignette in CRAN vs non-CRAN context #168

Merged
merged 14 commits into from
Feb 3, 2025

Conversation

RasmusSkytte
Copy link
Contributor

@RasmusSkytte RasmusSkytte commented Jan 13, 2025

Intent

Fixes #162

Approach

A PR on diseaystore (ssi-dk/diseasystore#185) fixed an issue with the data being plotted for the benchmarks on CRAN.
This PR implements these changes in the logic to ensure that when rendering on CRAN, we use the newest benchmarks.

In addition, the figures created on CRAN are the low resolution vignette figures that R uses for its vignettes.
These plots are adjusted so that they are readable now.

We therefore now first check if we are in a CRAN or non-CRAN context and then swap which benchmarks we plot and how they are plotted.

Example figures in a non-CRAN context (i.e. our website):
benchmark_1-1

benchmark_2-1

Example figures in a CRAN context (i.e. for the pre-rendered vignettes):
Uden titel

Uden titel

Known issues

N/A

Checklist

  • The PR passes all local unit tests
  • I have documented any new features introduced
  • If the PR adds a new feature, please add an entry in NEWS.md
  • A reviewer is assigned to this PR

@RasmusSkytte RasmusSkytte self-assigned this Jan 13, 2025
@RasmusSkytte RasmusSkytte force-pushed the fix/benchmark-vignette-rendering branch from e6cbf23 to 07197d9 Compare January 13, 2025 13:12
@RasmusSkytte RasmusSkytte added the documentation Improvements or additions to documentation label Jan 13, 2025
@RasmusSkytte RasmusSkytte force-pushed the fix/benchmark-vignette-rendering branch from b2b70f8 to aafd47e Compare January 13, 2025 14:01
@RasmusSkytte RasmusSkytte marked this pull request as ready for review January 13, 2025 14:14
@RasmusSkytte RasmusSkytte requested review from a team, kaare-gr, SofiaOtero and LasseEngboChr and removed request for a team January 13, 2025 14:15
@RasmusSkytte
Copy link
Contributor Author

This should be the last thing we need before we can release the next version of SCDB

@RasmusSkytte RasmusSkytte merged commit df1f2dd into main Feb 3, 2025
31 checks passed
@RasmusSkytte RasmusSkytte deleted the fix/benchmark-vignette-rendering branch February 3, 2025 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Benchmark vignette rendering logic
1 participant