perf: optimized core tabulation and summary functions; added benchmark suite#575
Open
kpagacz wants to merge 8 commits into
Open
Conversation
Contributor
|
✅ All contributors have signed the CLA |
Collaborator
Author
|
I have read the CLA Document and I hereby sign the CLA |
…com:kpagacz/cards into perf/ard-functions-performance-improvements
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
gtsummarynestdevs-tasks#118)The below 5 functions from the cards package contributed the most to runtime of the below gtsummary benchmark:
suppressPackageStartupMessages({ library(profvis) library(dplyr) library(gtsummary) }) # Replicate the trial dataset 10x to simulate a moderately sized dataset data_big <- trial[rep(seq_len(nrow(trial)), 10), ] # Run profvis to generate the interactive flame graph profvis({ for(i in 1:2) { tbl_strata( data_big, strata = grade, .tbl_fun = ~ .x |> tbl_summary(by = trt, include = c(age, marker)) ) } })A more detailed list:
ard_summary.data.frame : Replaced deeply nested purrr::map() , purrr::map2() , and dplyr::bind_rows() iterations within .calculate_stats_as_ard and .lst_results_as_df with lapply() and data.frame() assignments. (~36% speedup)
ard_tabulate.data.frame : refactored .calculate_tabulation_statistics to remove tidyr::pivot_longer and dplyr::mutate(across()) (~36% speedup)
tidy_ard_column_order & tidy_ard_row_order : removed tidyselect operations and dplyr::arrange , substituting them base R string searches ( grepl ) and order() vector-subsetting. (~28x speedup)
ard_tabulate_value.data.frame : replaced pmap with a vectorized O(N) which() / %in% base R scan. (~16x speedup)
ard_total_n.data.frame : Completely avoided a full-dataframe dplyr::mutate scan by creating a direct 1-row tibble object for the total N ARD object. (~45x speedup)
CI Additions:
Added .github/workflows/benchmark.yaml to trigger automated profiling workflows on PRs prefixed with perf: .
Unified benchmark code into .github/scripts/benchmark.R , which runs bench::mark() on core functions and automatically posts a markdown table reporting itr/sec and memory allocation directly to the PR comment thread.
Related to insightsengineering/nestdevs-tasks#118
Pre-review Checklist (if item does not apply, mark is as complete)
usethis::pr_merge_main()devtools::test_coverage()Reviewer Checklist (if item does not apply, mark is as complete)
pkgdown::build_site(). Check the R console for errors, and review the rendered website.devtools::test_coverage()When the branch is ready to be merged:
NEWS.mdwith the changes from this pull request under the heading "# cards (development version)". If there is an issue associated with the pull request, reference it in parentheses at the end update (seeNEWS.mdfor examples).Optional Reverse Dependency Checks:
Install
checkedwithpak::pak("Genentech/checked")orpak::pak("checked")