[skip vbump] Release v0.6.0 (#448)

llrs-roche · averissimo · web-flow · commit 348a7b162f98 · 2025-11-17T08:40:55.000Z
# Pull Request Fixes #416 Some minor adjustments to: - Version numbers used on deprecation messages. - Examples to keep examples in line with CRAN rules: (<5s) - URL updates to point to existing pages --------- Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com> Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -47,3 +47,4 @@ SECURITY.md
 ^.revdeprefs\.yaml$
 ^revdep$
 ^\.covrignore$
+.lock$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: teal.reporter
 Title: Reporting Tools for 'shiny' Modules
-Version: 0.5.0.9031
+Version: 0.6.0
 Date: 2025-11-14
 Authors@R: c(
     person("Dawid", "Kaledkowski", , "dawid.kaledkowski@roche.com", role = c("aut", "cre"),
diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# teal.reporter 0.5.0.9031
+# teal.reporter 0.6.0
 
 ### New features
 
diff --git a/R/ReportCard.R b/R/ReportCard.R
@@ -24,7 +24,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
     #'
     initialize = function() {
       lifecycle::deprecate_warn(
-        when = "0.5.1",
+        when = "0.6.0",
         what = "ReportCard$new()",
         with = "teal_card()",
         details = "Use teal_report class instead. See vignette('teal-report-class', 'teal.reporter') for more information." # nolint: line_length_linter.
@@ -201,7 +201,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
     #'
     to_list = function(output_dir = lifecycle::deprecated()) {
       if (lifecycle::is_present(output_dir)) {
-        lifecycle::deprecate_soft("0.5.0.9000", "ReportCard$to_list(output_dir)")
+        lifecycle::deprecate_soft("0.6.0", "ReportCard$to_list(output_dir)")
       }
       unclass(private$content)
     },
@@ -222,7 +222,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
     #'
     from_list = function(card, output_dir = lifecycle::deprecated()) {
       if (lifecycle::is_present(output_dir)) {
-        lifecycle::deprecate_soft("0.5.0.9000", "ReportCard$to_list(output_dir)")
+        lifecycle::deprecate_soft("0.6.0", "ReportCard$to_list(output_dir)")
       }
       self$reset()
       private$content <- as.teal_card(card)
diff --git a/R/Reporter.R b/R/Reporter.R
@@ -69,14 +69,9 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
     #' be set in this order.
     #' @description Reorders `teal_card` objects in `Reporter`.
     #' @return `self`, invisibly.
-    #' @examplesIf require("ggplot2")
-    #' library(ggplot2)
+    #' @examplesIf require("ggplot2") && require("rtables")
     #' library(rtables)
-    #'
-    #' card1 <- teal_card("## Header 2 text", "A paragraph of default text")
-    #' card1 <- c(card1, ggplot(iris, aes(x = Petal.Length)) + geom_histogram())
-    #' metadata(card1, "title") <- "Card1"
-    #'
+    #' # With the card1 from above
     #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
     #' table_res2 <- build_table(lyt, airquality)
     #' card2 <- teal_card(
@@ -101,24 +96,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
     #' @param card The new object (`ReportCard` or `teal_card`) to replace the existing one.
     #' @return `self`, invisibly.
     #' @examplesIf require("ggplot2")
-    #' library(ggplot2)
-    #' library(rtables)
-    #'
-    #' card1 <- teal_card("## Header 2 text", "A paragraph of default text")
-    #' card1 <- c(card1, ggplot(iris, aes(x = Petal.Length)) + geom_histogram())
-    #' metadata(card1, "title") <- "Card1"
-    #'
-    #' reporter <- Reporter$new()
-    #' reporter$append_cards(list(card1))
-    #'
-    #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
-    #' table_res2 <- build_table(lyt, airquality)
-    #' card2 <- teal_card(
-    #'   "## Header 2 text",
-    #'   "A paragraph of default text",
-    #'   table_res2
-    #' )
-    #' metadata(card2, "title") <- "Card2"
+    #' # With card1 and card2 from above
     #'
     #' metadata(reporter$get_cards()[[1]], "title")
     #' reporter$replace_card(card2, names(reporter$get_cards())[[1]])
@@ -134,19 +112,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
     #' @description Retrieves all `teal_card` objects contained in `Reporter`.
     #' @return A (`list`) of [`teal_card`] objects.
     #' @examplesIf require("ggplot2")
-    #' library(ggplot2)
-    #' library(rtables)
-    #'
-    #' card1 <- teal_card("## Header 2 text", "A paragraph of default text")
-    #' card1 <- c(card1, ggplot(iris, aes(x = Petal.Length)) + geom_histogram())
-    #'
-    #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
-    #' table_res2 <- build_table(lyt, airquality)
-    #' card2 <- teal_card(
-    #'   "## Header 2 text",
-    #'   "A paragraph of default text",
-    #'   table_res2
-    #' )
+    #' # With card1 and card2 from above
     #'
     #' reporter <- Reporter$new()
     #' reporter$append_cards(list(card1, card2))
@@ -167,19 +133,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
     #' Default is a `\n\\newpage\n` markdown.
     #' @return `list()` of `teal_card`
     #' @examplesIf require("ggplot2")
-    #' library(ggplot2)
-    #' library(rtables)
-    #'
-    #' card1 <- teal_card("## Header 2 text", "A paragraph of default text")
-    #' card1 <- c(card1, ggplot(iris, aes(x = Petal.Length)) + geom_histogram())
-    #'
-    #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
-    #' table_res2 <- build_table(lyt, airquality)
-    #' card2 <- teal_card(
-    #'   "## Header 2 text",
-    #'   "A paragraph of default text",
-    #'   table_res2
-    #' )
+    #' # With card1 and card2 from above
     #'
     #' reporter <- Reporter$new()
     #' reporter$append_cards(list(card1, card2))
@@ -261,7 +215,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
     #' reporter <- Reporter$new()
     #' reporter$from_reporter(reporter)
     from_reporter = function(reporter) {
-      lifecycle::deprecate_warn("0.5.0.9000", "Reporter$from_reporter()")
+      lifecycle::deprecate_warn("0.6.0", "Reporter$from_reporter()")
       checkmate::assert_class(reporter, "Reporter")
       self$reset()
       self$append_cards(reporter$get_cards())
diff --git a/R/previewer_deprecated.R b/R/previewer_deprecated.R
@@ -37,7 +37,7 @@ NULL
 reporter_previewer_ui <- function(id) {
   ns <- shiny::NS(id)
   lifecycle::deprecate_soft(
-    when = "0.5.0",
+    when = "0.6.0",
     what = "reporter_previewer_ui()",
     details = paste(
       "Calling `reporter_previewer_ui()` is deprecated and will be removed in the next release.\n",
@@ -80,7 +80,7 @@ reporter_previewer_srv <- function(id,
                                    rmd_yaml_args = getOption("teal.reporter.rmd_yaml_args"),
                                    previewer_buttons = c("download", "load", "reset")) {
   lifecycle::deprecate_soft(
-    when = "0.5.0",
+    when = "0.6.0",
     what = "reporter_previewer_srv()",
     details = paste(
       "Calling `reporter_previewer_srv()` is deprecated and will be removed in the next release.\n",
diff --git a/R/to_rmd.R b/R/to_rmd.R
@@ -70,7 +70,7 @@
 #' @examples
 #' to_rmd(c("## This is a simple text block.", "", "With a paragraph break."))
 #' to_rmd(code_chunk("summary(cars)"))
-#' to_rmd(data.frame(x = 1:10, y = 21:30))
+#' to_rmd(data.frame(x = 1:10, y = 21:30), folder_path = tempdir())
 #' @examplesIf requireNamespace("ggplot2", quietly = TRUE)
 #'
 #' # Example with ggplot2 will create a temporary RDS file in the tempdir()
diff --git a/man/Reporter.Rd b/man/Reporter.Rd
diff --git a/man/to_rmd.Rd b/man/to_rmd.Rd
diff --git a/tests/testthat/test-render.R b/tests/testthat/test-render.R
@@ -1,5 +1,5 @@
 with_temp_wd <- function() {
-  new_dir <- tempfile()
+  new_dir <- normalizePath(tempfile(), winslash = "/", mustWork = FALSE)
   dir.create(new_dir, recursive = TRUE)
   old_dir <- setwd(new_dir)
   withr::defer(setwd(old_dir), envir = parent.frame(2))
@@ -59,7 +59,7 @@ testthat::describe("render() outputs report.Rmd with", {
   withr::local_options(teal.reporter.global_knitr = list())
   it("output_dir set to other location then working directory", {
     tr <- teal_report()
-    temp_dir <- tempfile()
+    temp_dir <- normalizePath(tempfile(), winslash = "/", mustWork = FALSE)
     teal.reporter::render(tr, output_dir = temp_dir, quiet = TRUE)
     testthat::expect_true(file.exists(file.path(temp_dir, "report.Rmd")))
   })
@@ -207,7 +207,7 @@ testthat::describe("render() renders output based on metadata$output field:", {
   })
 
   it("- md_document containing relative path to a plot even if output_dir is set to absolute path", {
-    temp_dir <- tempfile()
+    temp_dir <- normalizePath(tempfile(), winslash = "/", mustWork = FALSE)
     tr <- teal_report()
     tr <- within(tr, plot(1:10))
     metadata(teal_card(tr)) <- list(output = "md_document")
diff --git a/vignettes/teal-report-class.Rmd b/vignettes/teal-report-class.Rmd
@@ -133,4 +133,4 @@ Using `teal_report` in your modules provides several advantages:
 
 For more details on the underlying `teal_data` functionality, see the [Introduction to teal.data](https://insightsengineering.github.io/teal.data/latest-tag/articles/teal-data.html).
 
-For more information on the `teal_report` class usage in `teal`, see the [Managing Reproducible Report Documents in teal](https://insightsengineering.github.io/teal/latest-tag/articles/managing-reproducible-report-documents-in-teal.html).
+For more information on the `teal_report` class usage in `teal`, see the [Adding support for Reproducible Report Documents in teal](https://insightsengineering.github.io/teal/latest-tag/articles/adding-support-for-reporting.html).

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# teal.reporter 0.5.0.9031`
	`1`	`+# teal.reporter 0.6.0`
`2`	`2`
`3`	`3`	`### New features`
`4`	`4`