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

Update ard_hierarchical() denominator argument description #374

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

edelarua
Copy link
Contributor

What changes are proposed in this pull request?

  • Updated denominator argument description for ard_hierarchical().

I copied over the description from ard_stack_hierarchical() with some minor modifications.

Closes #372


Pre-review Checklist (if item does not apply, mark is as complete)

  • All GitHub Action workflows pass with a ✅
  • PR branch has pulled the most recent updates from master branch: usethis::pr_merge_main()
  • If a bug was fixed, a unit test was added.
  • Code coverage is suitable for any new functions/features (generally, 100% coverage for new code): devtools::test_coverage()
  • Request a reviewer

Reviewer Checklist (if item does not apply, mark is as complete)

  • If a bug was fixed, a unit test was added.
  • Run pkgdown::build_site(). Check the R console for errors, and review the rendered website.
  • Code coverage is suitable for any new functions/features: devtools::test_coverage()

When the branch is ready to be merged:

  • Update NEWS.md with 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 (see NEWS.md for examples).
  • All GitHub Action workflows pass with a ✅
  • Approve Pull Request
  • Merge the PR. Please use "Squash and merge" or "Rebase and merge".

Optional Reverse Dependency Checks:

  • Install checked with pak::pak("Genentech/checked") or pak::pak("checked")

  • Check dev versions of cardx, gtsummary, and tfrmt which are in the ddsjoberg R Universe

    Rscript -e "options(checked.check_envvars = c(NOT_CRAN = TRUE)); checked::check_rev_deps(path = '.', repos = c('https://ddsjoberg.r-universe.dev', 'https://cloud.r-project.org'))"
  • Check CRAN reverse dependencies but run tests skipped on CRAN

    Rscript -e "options(checked.check_envvars = c(NOT_CRAN = TRUE)); checked::check_rev_deps(path = '.', repos = 'https://cloud.r-project.org')"
  • Check CRAN reverse dependencies in a CRAN-like environment

    Rscript -e "options(checked.check_envvars = c(NOT_CRAN = FALSE), checked.check_build_args = '--as-cran'); checked::check_rev_deps(path = '.', repos = 'https://cloud.r-project.org')"

@edelarua edelarua added the sme label Jan 15, 2025
Copy link
Contributor

github-actions bot commented Jan 15, 2025

Unit Tests Summary

  1 files  180 suites   51s ⏱️
177 tests 177 ✅ 0 💤 0 ❌
435 runs  435 ✅ 0 💤 0 ❌

Results for commit fe5847b.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Jan 15, 2025

Unit Test Performance Difference

Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
add_calculated_row 💔 $0.19$ $+1.11$ add_calculated_row_x_
ard_continuous 💚 $4.19$ $-3.95$ ard_continuous_works
ard_hierarchical 💔 $8.16$ $+1.17$ ard_hierarchical_works_without_by_variables
ard_strata 💔 $0.84$ $+2.14$ ard_strata_works

Results for commit a7b2ea5

♻️ This comment has been updated with latest results.

@edelarua edelarua requested a review from ddsjoberg January 15, 2025 23:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cards::ard_hierarchical() documentation check?
1 participant