Preparations for the release by llrs-roche · Pull Request #340 · insightsengineering/cardx

llrs-roche · 2026-05-22T16:06:54Z

This PR have some preparations for the release (related to #339)

What changes are proposed in this pull request?

Help pages were updated with roxygen2 v8.0.0 and made them pass devtools::check_doc_fields() .

The check resulted on deleting the help pages of the packages (but keep the roxygen2 documentation) and adding some fields on the deprecated.Rd file.

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.
If a new ard_*() function was added, it passes the ARD structural checks from cards::check_ard_structure().
If a new ard_*() function was added, set_cli_abort_call() has been set.
If a new ard_*() function was added and it depends on another package (such as, broom), is_pkg_installed("broom") has been set in the function call and the following added to the roxygen comments: @examplesIf do.call(asNamespace("cardx")$is_pkg_installed, list(pkg = "broom""))
Code coverage is suitable for any new functions/features (generally, 100% coverage for new code): devtools::test_coverage()

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

If a bug was fixed, a unit test was added.
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 "# cardx (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".

github-actions · 2026-05-22T16:12:27Z

Unit Tests Summary

1 files 193 suites 1m 22s ⏱️
191 tests 191 ✅ 0 💤 0 ❌
786 runs 786 ✅ 0 💤 0 ❌

Results for commit a4aef8d.

♻️ This comment has been updated with latest results.

github-actions · 2026-05-22T16:12:31Z

Unit Test Performance Difference

Additional test case details

Test Suite	$Status$	Time on `main`	$±Time$	Test Case
ard_categorical_ci.survey.design	💚	$3.04$	$-1.01$	ard_categorical_ci_data_
ard_summary.survey.design	💔	$23.14$	$+1.11$	unstratified_ard_summary.survey.design_works
ard_tabulate.survey.design	💚	$23.81$	$-1.14$	ard_tabulate.survey.design_works

Results for commit 8922dcd

♻️ This comment has been updated with latest results.

github-actions · 2026-05-22T16:12:48Z

Code Coverage Summary

Filename                                Stmts    Miss  Cover    Missing
------------------------------------  -------  ------  -------  -------------------------------------------
R/add_total_n.survey.design.R              10       0  100.00%
R/ard_aod_wald_test.R                      77       2  97.40%   93, 96
R/ard_attributes.survey.design.R            2       0  100.00%
R/ard_car_anova.R                          45       2  95.56%   62, 65
R/ard_car_vif.R                            68       1  98.53%   93
R/ard_categorical_ci.R                    323       1  99.69%   100
R/ard_categorical_ci.survey.design.R      124       1  99.19%   180
R/ard_continuous_ci.R                      28       1  96.43%   38
R/ard_continuous_ci.survey.design.R       138       0  100.00%
R/ard_continuous.survey.design.R          284      20  92.96%   61-66, 100, 191, 200, 351, 382-383, 434-442
R/ard_effectsize_cohens_d.R               103       2  98.06%   69, 122
R/ard_effectsize_hedges_g.R                91       2  97.80%   68, 120
R/ard_emmeans_contrast.R                   99       0  100.00%
R/ard_emmeans_emmeans.R                    97       0  100.00%
R/ard_incidence_rate.R                    104       0  100.00%
R/ard_missing.survey.design.R              89       7  92.13%   45-50, 63
R/ard_regression_basic.R                   31       1  96.77%   61
R/ard_regression.R                         87       0  100.00%
R/ard_smd_smd.R                            69       5  92.75%   57, 83-86
R/ard_stats_anova.R                        95       0  100.00%
R/ard_stats_aov.R                          46       0  100.00%
R/ard_stats_chisq_test.R                   40       1  97.50%   39
R/ard_stats_fisher_test.R                  43       1  97.67%   42
R/ard_stats_kruskal_test.R                 36       1  97.22%   38
R/ard_stats_mantelhaen_test.R              67       1  98.51%   45
R/ard_stats_mcnemar_test.R                 80       2  97.50%   63, 106
R/ard_stats_mood_test.R                    49       1  97.96%   45
R/ard_stats_oneway_test.R                  39       0  100.00%
R/ard_stats_poisson_test.R                 76       1  98.68%   59
R/ard_stats_prop_test.R                    85       1  98.82%   43
R/ard_stats_t_test_onesample.R             41       0  100.00%
R/ard_stats_t_test.R                      112       2  98.21%   65, 111
R/ard_stats_wilcox_test_onesample.R        42       0  100.00%
R/ard_stats_wilcox_test.R                  99       2  97.98%   65, 117
R/ard_survey_svychisq.R                    38       1  97.37%   44
R/ard_survey_svyranktest.R                 54       1  98.15%   44
R/ard_survey_svyttest.R                    53       1  98.11%   42
R/ard_survival_survdiff.R                  89       0  100.00%
R/ard_survival_survfit_diff.R              76       0  100.00%
R/ard_survival_survfit.R                  243       5  97.94%   234-238
R/ard_tabulate_abnormal.R                  76       0  100.00%
R/ard_tabulate_max.R                       51       7  86.27%   54-59, 74
R/ard_tabulate_value.survey.design.R       80       9  88.75%   40-45, 62, 167, 172
R/ard_tabulate.survey.design.R            407      15  96.31%   70-75, 90, 243-246, 290, 335, 535, 549
R/construction_helpers.R                  106      10  90.57%   160-175, 189, 248
R/deprecated.R                             34      34  0.00%    32-90
R/proportion_ci.R                         203       1  99.51%   463
TOTAL                                    4329     142  96.72%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: a4aef8d

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

ddsjoberg · 2026-05-26T03:54:58Z

 #' @param wald_test (`data.frame`)\cr wald test object object from `aod::wald.test()`
 #'
 #' @return a data frame containing the wald test results.
-#' @keywords internal


Please avoid making updates based on opinionated ways of documenting functions. I like having help files.

Noted, I will not remove internal help pages.

I removed the help page because CRAN requests to have examples and document values too for the internal help pages.
Internal help pages are not listed on the index but users can reach them if they want. I will simply fill in the section with NULL.

ddsjoberg · 2026-05-26T03:55:07Z

 #' @param ... passed to `prop.test(...)`
 #'
 #' @return ARD data frame
-#' @keywords internal


Same comment as above.

Noted, I will not remove internal help pages.

I removed the help page because CRAN requests to have examples and document values too for the internal help pages.
Internal help pages are not listed on the index but users can reach them if they want. I will simply fill in the sections with NULL.

llrs-roche added 3 commits May 22, 2026 15:13

Fixes issues with cross-links (Update documentation to latest roxygen2)

20c7bdc

Remove the help page for internal functions

f0bdda8

Prevent CRAN reviewer comments on missing sections

5d05073

ddsjoberg reviewed May 26, 2026

View reviewed changes

Add back the help pages

a4aef8d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Preparations for the release#340

Preparations for the release#340
llrs-roche wants to merge 4 commits into
mainfrom
339_support_release

llrs-roche commented May 22, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 22, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 22, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 22, 2026 •

edited

Loading

Uh oh!

ddsjoberg May 26, 2026

Uh oh!

llrs-roche May 26, 2026

Uh oh!

ddsjoberg May 26, 2026

Uh oh!

llrs-roche May 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

llrs-roche commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Tests Summary

Uh oh!

github-actions Bot commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Performance Difference

Uh oh!

github-actions Bot commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Diff against main

Uh oh!

ddsjoberg May 26, 2026

Choose a reason for hiding this comment

Uh oh!

llrs-roche May 26, 2026

Choose a reason for hiding this comment

Uh oh!

ddsjoberg May 26, 2026

Choose a reason for hiding this comment

Uh oh!

llrs-roche May 26, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

llrs-roche commented May 22, 2026 •

edited

Loading

github-actions Bot commented May 22, 2026 •

edited

Loading

github-actions Bot commented May 22, 2026 •

edited

Loading

github-actions Bot commented May 22, 2026 •

edited

Loading