Deprecate footnotes and removing wrap_text

DESCRIPTION

@@ -150,4 +150,3 @@ Collate:
     'utils_factor.R'
     'utils_grid.R'
     'utils_rtables.R'
-    'wrap_text.R'

NEWS.md

@@ -6,7 +6,6 @@
   function to speed up data set loading in tests/examples.
 * Updated all tests to use `rcd_2022_06_27` version of cached data.
 * Added more tests to increase code coverage.
-* Deprecated badge and warning for `wrap_txt` and its file.
 * Added legend to `g_step`.
 * Added formatting functions `format_fraction_fixed_dp` and 
   `format_count_fraction_fixed_dp` with fixed single decimal place in percentages.
@@ -51,6 +50,8 @@
 * Created separate `.R` files for logistic regression and cox regression helper functions.
 * Removed all template tests from `tern`. These tests are in internal repo `scda.test`.
 * Replaced deprecated function `forcats::fct_explicit_na` with `forcats::fct_na_value_to_level`.
+* Removal of deprecated `wrap_text` and related files.
+* Deprecation cycle started for `footnotes` functions.
 
 # tern 0.7.10
 

R/footnotes.R

@@ -1,6 +1,6 @@
 #' Assign Footnotes
 #'
-#' @description `r lifecycle::badge("stable")`
+#' @description `r lifecycle::badge("deprecated")`
 #'
 #' Assign value to attribute footnote of object `x`.
 #'
@@ -12,14 +12,15 @@
 #' footnotes(x) <- "Species are equally distributed"
 #' attributes(x)
 `footnotes<-` <- function(x, value = NULL) { # nolint
+  dep_msg <- 'Please use current implementation in rtables or directly attr(x, "footnote")'
+  lifecycle::deprecate_warn("0.7.11", "footnotes()", details = dep_msg)
   attr(x, "footnote") <- value
   x
 }
 
-
 #' Retrieve Footnotes
 #'
-#' @description `r lifecycle::badge("stable")`
+#' @description `r lifecycle::badge("deprecated")`
 #'
 #' Retrieve value from attribute `footnote` of object `x`.
 #'
@@ -30,12 +31,14 @@
 #' footnotes(x) <- "Species are equally distributed"
 #' footnotes(x)
 footnotes <- function(x) {
+  dep_msg <- 'Please use current implementation in rtables or directly attr(x, "footnote")'
+  lifecycle::deprecate_warn("0.7.11", "footnotes()", details = dep_msg)
   attr(x, "footnote")
 }
 
 #' Add Footnotes
 #'
-#' @description `r lifecycle::badge("stable")`
+#' @description `r lifecycle::badge("deprecated")`
 #'
 #' This adds more footnotes.
 #'
@@ -49,6 +52,8 @@ footnotes <- function(x) {
 #' add_footnotes(x) <- "Add more footnotes"
 #' footnotes(x)
 `add_footnotes<-` <- function(x, value) { # nolint
+  dep_msg <- 'Please use current implementation in rtables or directly attr(x, "footnote")'
+  lifecycle::deprecate_warn("0.7.11", "add_footnotes()", details = dep_msg)
   footnotes(x) <- c(footnotes(x), value)
   x
 }

R/g_forest.R

@@ -246,12 +246,6 @@ g_forest <- function(tbl, # nolint
     vp = grid::plotViewport(margins = rep(1, 4))
   )
 
-  fn <- footnotes(tbl)
-  if (!is.null(fn)) {
-    footnotes(grob_forest) <- fn
-    message("grob footnote is not added to plot; suggest to use decorate_grob() to further decorate the grob")
-  }
-
   if (draw) {
     if (newpage) grid::grid.newpage()
     grid::grid.draw(grob_forest)

tests/testthat/test-footnotes.R

@@ -2,7 +2,7 @@ testthat::test_that("footnotes works correctly", {
   x <- table(iris$Species)
   footnotes(x) <- "Species are equally distributed"
 
-  res <- testthat::expect_silent(footnotes(x))
+  res <- footnotes(x)
   testthat::expect_snapshot(res)
 })
 
@@ -11,6 +11,6 @@ testthat::test_that("add_footnotes works correctly", {
   footnotes(x) <- "Species are equally distributed"
   add_footnotes(x) <- "Add more footnotes"
 
-  res <- testthat::expect_silent(footnotes(x))
+  res <- footnotes(x)
   testthat::expect_snapshot(res)
 })