Skip to content

Feature/issue-137-print-improvements #477

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

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

Conversation

kimjj93
Copy link
Collaborator

@kimjj93 kimjj93 commented Jul 8, 2025

What changes are proposed in this pull request?

  • Style this entry in a way that can be copied directly into NEWS.md. (#, @)

Provide more detail here as needed.

Reference GitHub issue associated with pull request. e.g., 'closes #'


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 = '.', n = parallel::detectCores() - 2L, 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 = '.', n = parallel::detectCores() - 2, 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 = '.', n = parallel::detectCores() - 2, repos = 'https://cloud.r-project.org')"

@kimjj93 kimjj93 marked this pull request as ready for review July 9, 2025 14:13
Copy link
Contributor

github-actions bot commented Jul 9, 2025

Unit Tests Summary

  1 files  197 suites   51s ⏱️
196 tests 105 ✅  91 💤 0 ❌
379 runs  266 ✅ 113 💤 0 ❌

Results for commit a8b7e6d.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Jul 9, 2025

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
selectors 💚 $1.61$ $-1.06$ $0$ $0$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
ard_continuous 💀 $0.07$ $-0.07$ unnamed
selectors 👶 $+0.04$ unnamed
selectors 💚 $1.61$ $-1.06$ selectors_work

Results for commit 9adb7bf

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Jul 9, 2025

badge

Code Coverage Summary

Filename                       Stmts    Miss  Cover    Missing
---------------------------  -------  ------  -------  ----------------------------------------
R/add_calculated_row.R            53       6  88.68%   51-56
R/apply_fmt_fun.R                116       0  100.00%
R/ard_attributes.R                46       1  97.83%   57
R/ard_categorical.R              400      16  96.00%   126-131, 259, 472-476, 483-484, 661, 695
R/ard_complex.R                   43       7  83.72%   76-81, 94
R/ard_continuous.R               194       8  95.88%   87-92, 220-221
R/ard_dichotomous.R               87       7  91.95%   51-56, 73
R/ard_formals.R                   13       0  100.00%
R/ard_hierarchical.R              94      12  87.23%   88-93, 179-184
R/ard_identity.R                  13       0  100.00%
R/ard_missing.R                   65       7  89.23%   45-50, 61
R/ard_pairwise.R                  46       0  100.00%
R/ard_stack_hierarchical.R       266       1  99.62%   489
R/ard_stack.R                     90       1  98.89%   117
R/ard_strata.R                    33       0  100.00%
R/ard_total_n.R                   10       0  100.00%
R/as_card_fn.R                     8       0  100.00%
R/as_card.R                        5       0  100.00%
R/as_nested_list.R                41       0  100.00%
R/bind_ard.R                      47      11  76.60%   74-85
R/cards-package.R                  1       1  0.00%    14
R/check_ard_structure.R           39       6  84.62%   31, 55-59
R/default_stat_labels.R           20       0  100.00%
R/deprecated.R                    24      24  0.00%    22-65
R/eval_capture_conditions.R       30       0  100.00%
R/filter_ard_hierarchical.R      104       1  99.04%   140
R/get_ard_statistics.R            16       0  100.00%
R/mock.R                         137       2  98.54%   116, 244
R/nest_for_ard.R                  71       1  98.59%   60
R/print_ard_conditions.R          83       0  100.00%
R/print.R                         79       1  98.73%   42
R/process_selectors.R            126       1  99.21%   337
R/rename_ard_columns.R            73       0  100.00%
R/rename_ard_groups.R             60       0  100.00%
R/replace_null_statistic.R        11       0  100.00%
R/round5.R                         1       0  100.00%
R/selectors.R                     23       0  100.00%
R/shuffle_ard.R                  118       0  100.00%
R/sort_ard_hierarchical.R        208       1  99.52%   285
R/summary_functions.R             25       1  96.00%   59
R/tidy_ard_order.R                34       0  100.00%
R/tidy_as_ard.R                   40       0  100.00%
R/unlist_ard_columns.R            27       0  100.00%
R/update_ard.R                    60       6  90.00%   54-59
R/utils.R                         24       0  100.00%
TOTAL                           3104     122  96.07%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  -------
R/print.R        -1      +1  -1.27%
TOTAL            -1      +1  -0.03%

Results for commit: bb5a6b1

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@kimjj93 kimjj93 self-assigned this Jul 9, 2025
@ddsjoberg
Copy link
Collaborator

Hi @kimjj93 ! Before we review, can you resolve the merge conflict and also outline all the changes to the print method (user facing), and give a brief outline of how you went about making that change?

@kimjj93
Copy link
Collaborator Author

kimjj93 commented Jul 23, 2025

Hi @ddsjoberg - based on the #137, I added the width option to read from the env.
Also, added the section header, footer indicating the truncation and cleaner column alignment.
Let me know if this is different from what you were proposing - I'll review once I am back from vacation. Thanks!

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