Merge branch 'main' into 911_summarize_vars_bug@main

insightsengineering · May 17, 2023 · 64e3089 · 64e3089
2 parents 87ec1ed + ef3e5e5
commit 64e3089
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 5 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -14,6 +14,7 @@
 * Added new "Analyze Functions" and "Summarize Functions" overview pages.
 * Moved all KM plot documentation to the `g_km` function.
 * Added `a_count_patients_sum_exposure` for new analyze function `analyze_patients_exposure_in_cols` and `summarize_patients_exposure_in_cols`.
+* Added more informative error when the user selects an invalid method for unstratified analyses in `s_proportion_diff`.
 
 ### Miscellaneous
 * Implemented the `lubridate` package for date variables in `tern` datasets.

diff --git a/R/prop_diff.R b/R/prop_diff.R
@@ -18,6 +18,9 @@ NULL
 #' @return
 #' * `s_proportion_diff()` returns a named list of elements `diff` and `diff_ci`.
 #'
+#' @note When performing an unstratified analysis, methods `"cmh"`, `"strat_newcombe"`, and `"strat_newcombecc"` are
+#'   not permitted.
+#'
 #' @examples
 #' # Summary
 #'
@@ -65,6 +68,12 @@ s_proportion_diff <- function(df,
                               ),
                               weights_method = "cmh") {
   method <- match.arg(method)
+  if (is.null(variables$strata) && checkmate::test_subset(method, c("cmh", "strat_newcombe", "strat_newcombecc"))) {
+    stop(paste(
+      "When performing an unstratified analysis, methods 'cmh', 'strat_newcombe', and 'strat_newcombecc' are not",
+      "permitted. Please choose a different method."
+    ))
+  }
   y <- list(diff = "", diff_ci = "")
 
   if (!.in_ref_col) {

diff --git a/man/prop_diff.Rd b/man/prop_diff.Rd
diff --git a/tests/testthat/_snaps/summarize_coxreg.md b/tests/testthat/_snaps/summarize_coxreg.md
@@ -43,7 +43,7 @@
         row_name formatted_cell indent_mod row_label
       1  Label 1            340          0   Label 1
 
-# summarize_coxreg adds the univariable Cox regression layer to rtables
+# summarize_coxreg adds the univariate Cox regression layer to rtables
 
     Code
       res
@@ -97,7 +97,7 @@
        * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
         Sex (F/M)           340       0.62       (0.42, 0.92)   0.0182 
 
-# summarize_coxreg works with interactions in univariable case
+# summarize_coxreg works with interactions in univariate case
 
     Code
       res
@@ -118,7 +118,7 @@
           F                           0.67       (0.36, 1.22)                                
           M                           0.60       (0.36, 0.99)                                
 
-# summarize_coxreg 'at' argument works in univariable case
+# summarize_coxreg 'at' argument works in univariate case
 
     Code
       res
@@ -155,7 +155,7 @@
           F                           0.67       (0.36, 1.22)                     ---        
           M                           0.60       (0.36, 0.99)                     ---        
 
-# summarize_coxreg works without treatment arm in univariable case
+# summarize_coxreg works without treatment arm in univariate case
 
     Code
       res
@@ -170,7 +170,7 @@
         Sex (F/M) (reference = F)                                                
           M                                     1.33       (0.97, 1.82)   0.1414 
 
-# summarize_coxreg works with numeric covariate without treatment arm in univariable case
+# summarize_coxreg works with numeric covariate without treatment arm in univariate case
 
     Code
       res