Use group_var argument to control_lineplot_vars instead of deprec…

…ated `strata` (#1223) Fixes #1222
insightsengineering · Sep 6, 2024 · 3ee96e5 · 3ee96e5
1 parent 99c2813
commit 3ee96e5
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 7 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -60,7 +60,7 @@ Imports:
     teal.logger (>= 0.2.0.9004),
     teal.reporter (>= 0.2.1),
     teal.widgets (>= 0.4.0),
-    tern.gee (>= 0.1.4),
+    tern.gee (>= 0.1.5),
     tern.mmrm (>= 0.3.1),
     utils,
     vistime (>= 1.2.3)

diff --git a/NEWS.md b/NEWS.md
@@ -14,6 +14,7 @@
 * Clarified the documentation specifying whether multiple values can be selected in the `arm_var` argument for each module.
 * Replaced use of the `rtables::add_colcounts()` function with the `show_colcounts` argument to `basic_table()`.
 * Began deprecation cycle for the `show_labels` argument of `template_summary` which has no effect on the `tm_t_summary` module.
+* Replaced instances of deprecated `strata` argument to `tern::control_lineplot_vars()` with `group_var`.
 
 # teal.modules.clinical 0.9.1
 

diff --git a/R/tm_g_lineplot.R b/R/tm_g_lineplot.R
@@ -5,6 +5,7 @@
 #' @inheritParams tern::g_lineplot
 #' @inheritParams tern::control_lineplot_vars
 #' @inheritParams template_arguments
+#' @param strata (`string` or `NA`)\cr group variable name.
 #' @param param (`character`)\cr parameter to filter the data by.
 #' @param incl_screen (`logical`)\cr whether the screening visit should be included.
 #' @param ggplot2_args (`ggplot2_args`) optional\cr object created by [teal.widgets::ggplot2_args()] with settings
@@ -94,7 +95,7 @@ template_g_lineplot <- function(dataname = "ANL",
   )
 
   z$variables <- substitute(
-    expr = variables <- control_lineplot_vars(x = x, y = y, strata = arm, paramcd = paramcd, y_unit = y_unit),
+    expr = variables <- control_lineplot_vars(x = x, y = y, group_var = arm, paramcd = paramcd, y_unit = y_unit),
     env = list(x = x, y = y, arm = strata, paramcd = paramcd, y_unit = y_unit)
   )
 

diff --git a/README.md b/README.md
@@ -64,7 +64,7 @@ install.packages('teal.modules.clinical')
 pak::pak("insightsengineering/teal.modules.clinical@*release")
 ```
 
-Alternatively, you might want to use the development version available on [r-universe](https://r-universe.dev/).
+Alternatively, you might want to use the development version available on [r-universe](https://r-universe.dev/search).
 
 ```r
 # beta versions

diff --git a/man/template_g_lineplot.Rd b/man/template_g_lineplot.Rd
diff --git a/man/tm_g_lineplot.Rd b/man/tm_g_lineplot.Rd
diff --git a/tests/testthat/_snaps/tm_g_lineplot.md b/tests/testthat/_snaps/tm_g_lineplot.md
@@ -10,7 +10,7 @@
       
       $variables
       variables <- control_lineplot_vars(x = "AVISIT", y = "AVAL", 
-          strata = "ARM", paramcd = "PARAMCD", y_unit = "AVALU")
+          group_var = "ARM", paramcd = "PARAMCD", y_unit = "AVALU")
       
       $graph
       {
@@ -40,7 +40,7 @@
       }
       
       $variables
-      variables <- control_lineplot_vars(x = "AVISIT", y = "CHG", strata = "ARMCD", 
+      variables <- control_lineplot_vars(x = "AVISIT", y = "CHG", group_var = "ARMCD", 
           paramcd = "PARAMCD", y_unit = "AVALU")
       
       $graph