Releases: pharmaverse/cardx
Release list
v0.3.4
- Fixed bug in
ard_stats_mantelhaen_test()where arguments were passed tostats::mantelhaen.test()positionally rather than by name, causing a test failure and incorrect results under R-devel. (#343)
What's Changed
- Fix ard_stats_mantelhaen_test() failure on R-devel by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/343
- Reduce mantelhaen.test() choice-argument defaults to scalars for R-devel by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/349
Full Changelog: insightsengineering/cardx@v0.3.3...v0.3.4
v0.3.3
- Fixed bug in
extract_strata()where parentheses in strata level labels were incorrectly stripped, e.g."Drug (B)"was truncated to"B". (#2388) - Added fix to ensure
as_carddoes not error after update tocards - Bug fix in
ard_car_vif()where non-syntactic variable names (e.g. those containing spaces) were returned with backticks in thevariablecolumn. Sincegtsummary::tbl_regression()stores variable names without backticks, this mismatch resulted in empty VIF columns ingtsummary::add_vif(). (#335, @NourEdinDarwish)
What's Changed
- Add as_card(check=FALSE) by @kieranjmartin in https://github.com/insightsengineering/cardx/pull/329
- fix: strip backticks from variable names in ard_car_vif() by @NourEdinDarwish in https://github.com/insightsengineering/cardx/pull/336
- Fix extract_strata() stripping parentheses from strata level labels by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/338
- Preparations for the release by @llrs-roche in https://github.com/insightsengineering/cardx/pull/340
New Contributors
- @kieranjmartin made their first contribution in https://github.com/insightsengineering/cardx/pull/329
- @NourEdinDarwish made their first contribution in https://github.com/insightsengineering/cardx/pull/336
Full Changelog: insightsengineering/cardx@v0.3.2...v0.3.3
v0.3.2
- Swapped internal use of
dplyr::case_when()fordplyr::recode_values()as the former is now deprecated. (#327)
Full Changelog: insightsengineering/cardx@v0.3.1...v0.3.2
v0.3.1
- Added the
ard_emmeans_emmeans()function. (#317) - Renamed
ard_emmeans_mean_difference()toard_emmeans_contrast()to align with function naming conventions. - The
ard_complex()function has been renamed toard_mvsummary().
What's Changed
- draft for mean.estimates included in mean.difference.estimates (ANCOVA in tern) by @ayogasekaram in https://github.com/insightsengineering/cardx/pull/265
- Split
ard_emmeans_mean_difference()function intoard_emmeans_contrast()andard_emmeans_emmeans()by @edelarua in https://github.com/insightsengineering/cardx/pull/318 - Use
skip_if_pkg_not_installed()by @edelarua in https://github.com/insightsengineering/cardx/pull/321 - Add insightsengineering/crane to .revdeprefs.yaml by @shajoezhu in https://github.com/insightsengineering/cardx/pull/323
- Add coda package dependency by @shajoezhu in https://github.com/insightsengineering/cardx/pull/324
- Update DESCRIPTION: deps update by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/325
Full Changelog: insightsengineering/cardx@v0.3.0...v0.3.1
v0.3.0
New Features and Updates
- Added function
ard_tabulate_abnormal()to calculate ARDs for abnormality analyses. (#310) - Adding
strataargument toard_tabulate_max(). (#445, @jtalboys) - Added function
ard_incidence_rate()to calculate ARDs for incidence rate estimation. (#234)
Lifecycle Changes
-
The following functions have been renamed.
ard_continuous()toard_summary()ard_categorical()toard_tabulate()ard_dichotomous()toard_tabulate_value()ard_categorical_max()toard_tabulate_max()
-
Updating any
fmt_fnreferences tofmt_funfor consistency.- Any function with an argument
cardx::foo(fmt_fn)has been updated tocardx::foo(fmt_fun). The old syntax will continue to function, but with a deprecation warning to users. - Importantly, the ARD column named
"fmt_fn"has been updated to"fmt_fun". This change cannot be formally deprecated. For users who were accessing the ARD object directly to modify this column instead of using functions likecards::update_ard_fmt_fun(), this will be a breaking change.
- Any function with an argument
Bug Fixes
- Fix in
ard_survival_survfit.data.frame()method where the stratifying variable was not correctly converted back to its original type. - Fix in
ard_total_n.survey.design()to useupdate()instead ofdplyr::mutate(), which sometimes caused a downstream issue.
What's Changed
- Add
ard_abnormal()for abnormality calculations by @edelarua in https://github.com/insightsengineering/cardx/pull/311 - Surface
deffargument and set default toFALSEby @malcolmbarrett in https://github.com/insightsengineering/cardx/pull/313 - Core function renames by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/315
New Contributors
- @malcolmbarrett made their first contribution in https://github.com/insightsengineering/cardx/pull/313
Full Changelog: insightsengineering/cardx@v0.2.5...v0.3.0
v0.2.5
-
Adding
strataargument toard_categorical_max(). (#445, @jtalboys) -
Added function
ard_incidence_rate()to calculate ARDs for incidence rate estimation. (#234) -
Updating any
fmt_fnreferences tofmt_funfor consistency.- Any function with an argument
cardx::foo(fmt_fn)has been updated tocardx::foo(fmt_fun). The old syntax will continue to function, but with a deprecation warning to users. - Importantly, the ARD column named
"fmt_fn"has been updated to"fmt_fun". This change cannot be formally deprecated. For users who were accessing the ARD object directly to modify this column instead of using functions likecards::update_ard_fmt_fun(), this will be a breaking change.
- Any function with an argument
-
Fix in
ard_survival_survfit.data.frame()method where the stratifying variable was not correctly converted back to its original type. -
Fix in
ard_total_n.survey.design()to useupdate()instead ofdplyr::mutate(), which sometimes caused a downstream issue.
What's Changed
- Add
ard_incidence_rate()by @edelarua in https://github.com/insightsengineering/cardx/pull/280 - update forcats standalone script by @ayogasekaram in https://github.com/insightsengineering/cardx/pull/297
- Fix in
ard_survival_survfit.data.frame()type conversion by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/298 - Add strata argument to ard_categorical_max by @jtalboys in https://github.com/insightsengineering/cardx/pull/300
- Fmt fn to fmt fun by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/302
- 267 add unit test@main by @ayogasekaram in https://github.com/insightsengineering/cardx/pull/293
New Contributors
- @jtalboys made their first contribution in https://github.com/insightsengineering/cardx/pull/300
Full Changelog: insightsengineering/cardx@v0.2.4...v0.2.5
v0.2.4
New Features and Updates
- Added function
ard_stats_mantelhaen_test()to calculate ARDs for Cochran-Mantel-Haenszel test results usingstats::mantelhaen.test(). (#238) - Added a
ard_regression.data.frame()S3 method. Also convertedard_regression_basic()to an S3 generic and added aard_regression_basic.data.frame()method (#287) - Specifying
ard_survfit_survfit.data.frame(variables=NULL)now creates an unstratifiedsurvfit()model, where previouslyvariablesargument could not be empty. (#277) - The
ard_survfit_survfit.data.frame(variables)now accepts tidyselect input. (#278) - Added
conf.levelandconf.typetoard_survival_survfit()results. (#218) - Added
cards::as_cards_fun()toard_emmeans_mean_difference()so when an error occurs the user gets an ARD with the expected ARD structure. (#132)
What's Changed
- Add parameter checks to
ard_survival_survfit()by @edelarua in https://github.com/insightsengineering/cardx/pull/276 - pull changes from standalone script by @ayogasekaram in https://github.com/insightsengineering/cardx/pull/273
ard_survfit_survfit.data.frame()can now construct unstratified model by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/279- Adding
ard_regression.data.frame()method by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/288 - Add
conf.leveltoard_survival_survfit()results by @edelarua in https://github.com/insightsengineering/cardx/pull/282 - Capture errors from
ard_emmeans_mean_difference()usingas_cards_fn()by @edelarua in https://github.com/insightsengineering/cardx/pull/283 - Add
ard_stats_mantelhaen_test()by @edelarua in https://github.com/insightsengineering/cardx/pull/246 - Returning
ard_survival_survfit()conf.level as numeric (was previously character) by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/291
Full Changelog: insightsengineering/cardx@v0.2.3...v0.2.4
v0.2.3
New Features and Updates
- Added function
ard_categorical_max()to calculate categorical occurrence rates by maximum level per unique ID. (#240)
Other Updates
- Little
nis now returned with the results of theproportion_ci_*()functions, which then flows into the results ofard_proportion_ci(). (#256) - Added
as_cards_fun()toard_categorical_ci()so when there is an error, the user gets an ARD with the expected ARD structure. (#262) - Update in
ard_categorical.survey.design()for factor variables that are all missing. These variables can now be tabulated, where previously this resulted in an error. - Update in
ard_missing.survey.design()where we can now tabulate the missing rate of design variables, such as the weights.
Bug Fixes
- Fixed a bug in
ard_survival_survfit()causing an error when "=" character is present in stratification variable level labels. (#252) - Bug fix in
ard_categorical_ci(denominator='cell')when missing values were present in thebyvariable.
What's Changed
- update for fct variables that are all NA by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/248
- Replace logo.png by logo.svg by @llrs-roche in https://github.com/insightsengineering/cardx/pull/249
- Fix in ard_missing() for design variables by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/250
- Adding
ard_categorical_ci(denominator)argument by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/251 - Revert to png logo by @llrs-roche in https://github.com/insightsengineering/cardx/pull/254
- cleaning up by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/255
- Fix bug in
ard_survival_survfit()when "=" is in strata variable labels by @edelarua in https://github.com/insightsengineering/cardx/pull/253 - Add
ard_categorical_max()by @edelarua in https://github.com/insightsengineering/cardx/pull/244 - Fix failing integration test by @edelarua in https://github.com/insightsengineering/cardx/pull/258
- Removed spelling from DESCRIPTION, similar to what was done in cards by @kimjj93 in https://github.com/insightsengineering/cardx/pull/259
- Adding
nto theproportion_ci*()results by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/260 - Adding
as_cards_fun()toard_categorical_ci()by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/263 - better handling of NA values in
ard_categorical_ci()by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/266 - Increase cards min version req by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/268
- release prep by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/271
- Remove lookup-refs by @m7pr in https://github.com/insightsengineering/cardx/pull/264
New Contributors
- @llrs-roche made their first contribution in https://github.com/insightsengineering/cardx/pull/249
- @kimjj93 made their first contribution in https://github.com/insightsengineering/cardx/pull/259
- @m7pr made their first contribution in https://github.com/insightsengineering/cardx/pull/264
Full Changelog: insightsengineering/cardx@v0.2.2...v0.2.3
v0.2.2
- Added a
data.framemethod toard_survival_survfit(). - Added a warning for incorrect formula type to
ard_survival_survfit(). (#223) - Implemented
summary(extend=TRUE)inard_survival_survfit()to return results for time points out of bounds. (#224) - Methods in the {survey} and {survival} packages do not retain inputs variables types in their outputs. We now are able retain these variable types in ARDs returned by
ard_continuous.survey.design(),ard_categorical.survey.design(),ard_continuous_ci.survey.design(),ard_categorical_ci.survey.design(), andard_survival_survfit.data.frame()(and notably, not inard_survival_survfit.survfit()).
What's Changed
- Update DESCRIPTION by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/209
- Workflow propagations by @walkowif in https://github.com/insightsengineering/cardx/pull/206
- align lme4 version with current rspm version by @shajoezhu in https://github.com/insightsengineering/cardx/pull/211
- adding example specifying conf level in
ard_survival_survfit()by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/217 - update tests by @ayogasekaram in https://github.com/insightsengineering/cardx/pull/220
- 213 update standalone@main by @ayogasekaram in https://github.com/insightsengineering/cardx/pull/225
- Enhance formula processing in
ard_survival_survfit()by @edelarua in https://github.com/insightsengineering/cardx/pull/226 - Update check.yaml by @shajoezhu in https://github.com/insightsengineering/cardx/pull/230
- add ard_categorical_ci.data.frame tests. by @ayogasekaram in https://github.com/insightsengineering/cardx/pull/228
- Update scheduled.yaml by @pawelru in https://github.com/insightsengineering/cardx/pull/232
- Added function to restore types in ARDs by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/231
New Contributors
- @shajoezhu made their first contribution in https://github.com/insightsengineering/cardx/pull/211
- @pawelru made their first contribution in https://github.com/insightsengineering/cardx/pull/232
Full Changelog: insightsengineering/cardx@v0.2.1...v0.2.2
v0.2.1
New Features and Updates
- Added S3 method
ard_total_n.survey.design()which returns an ARD with both the survey-weighted and unweighted total sample size. - Added
warninganderrorcolumns toard_regression()output. (#148) - Implemented
cards::as_card()where needed in the package to convert data frames to class 'card'. (#200)
Bug Fixes
- Bug fix in
ard_categorical.survey.design()where all unweighted statistics were returned, even in the case where they were explicitly not requested.
Lifecycle Changes
- The
bt(pattern),reformulate2(pattern_term),reformulate2(pattern_response)arguments have been deprecated and are now ignored. We now usemake.names()to determine whether a column name needs to be wrapped in backticks. (#192)
What's Changed
- Workflow propagations by @walkowif in https://github.com/insightsengineering/cardx/pull/191
- Add website URL to DESCRIPTION by @edelarua in https://github.com/insightsengineering/cardx/pull/190
- Update pkgdown site logo by @edelarua in https://github.com/insightsengineering/cardx/pull/196
- Adding
ard_total_n.survey.design()S3 method by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/199 - Add
warninganderrorcolumns toard_regression()output by @edelarua in https://github.com/insightsengineering/cardx/pull/195 - Implement
cards::as_card()by @edelarua in https://github.com/insightsengineering/cardx/pull/201 - add
check_ard_structure()unit tests by @ayogasekaram in https://github.com/insightsengineering/cardx/pull/197 - Add
ard_*()function forstats::poisson.test()by @edelarua in https://github.com/insightsengineering/cardx/pull/194 bt(pattern)update by @ddsjoberg in https://github.com/insightsengineering/cardx/pull/207
Full Changelog: insightsengineering/cardx@v0.2.0...v0.2.1