From d7acb645f857feca162c6b708d2ed37c737e3bd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Llu=C3=ADs=20Revilla?= Date: Tue, 21 Jan 2025 14:54:23 +0100 Subject: [PATCH 1/3] Make sure the docs are consistent with the code. --- R/ReportCard.R | 2 +- man/ReportCard.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/ReportCard.R b/R/ReportCard.R index c0221751..34967041 100644 --- a/R/ReportCard.R +++ b/R/ReportCard.R @@ -72,7 +72,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter. #' @description Appends a text paragraph to this `ReportCard`. #' #' @param text (`character`) The text content to add. - #' @param style (`character(1)`) the style of the paragraph. One of: `default`, `header`, `verbatim` + #' @param style (`character(1)`) the style of the paragraph. One of: `r TextBlock$new()$get_available_styles()`. #' @return `self`, invisibly. #' @examples #' card <- ReportCard$new()$append_text("A paragraph of default text") diff --git a/man/ReportCard.Rd b/man/ReportCard.Rd index 2e3b41e0..b3702923 100644 --- a/man/ReportCard.Rd +++ b/man/ReportCard.Rd @@ -266,7 +266,7 @@ Appends a text paragraph to this \code{ReportCard}. \describe{ \item{\code{text}}{(\code{character}) The text content to add.} -\item{\code{style}}{(\code{character(1)}) the style of the paragraph. One of: \code{default}, \code{header}, \code{verbatim}} +\item{\code{style}}{(\code{character(1)}) the style of the paragraph. One of: default, header2, header3, verbatim.} } \if{html}{\out{}} } From 15a4cca33bd99332356a05b9ecdad2063be47c8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Llu=C3=ADs=20Revilla?= Date: Tue, 21 Jan 2025 14:55:07 +0100 Subject: [PATCH 2/3] Match between text and code in the examples --- R/Renderer.R | 4 ++-- R/Reporter.R | 12 ++++++------ man/Renderer.Rd | 4 ++-- man/Reporter.Rd | 12 ++++++------ 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/R/Renderer.R b/R/Renderer.R index 8ff3996b..15024922 100644 --- a/R/Renderer.R +++ b/R/Renderer.R @@ -56,7 +56,7 @@ Renderer <- R6::R6Class( # nolint: object_name_linter. #' card2 <- ReportCard$new() #' #' card2$append_text("Header 2 text", "header2") - #' card2$append_text("A paragraph of default text", "header2") + #' card2$append_text("A paragraph of default text") #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) #' table_res2 <- build_table(lyt, airquality) #' card2$append_table(table_res2) @@ -160,7 +160,7 @@ Renderer <- R6::R6Class( # nolint: object_name_linter. #' card2 <- ReportCard$new() #' #' card2$append_text("Header 2 text", "header2") - #' card2$append_text("A paragraph of default text", "header2") + #' card2$append_text("A paragraph of default text") #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) #' table_res2 <- build_table(lyt, airquality) #' card2$append_table(table_res2) diff --git a/R/Reporter.R b/R/Reporter.R index aef2bf53..3b8bb463 100644 --- a/R/Reporter.R +++ b/R/Reporter.R @@ -32,7 +32,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter. #' card1 <- ReportCard$new() #' #' card1$append_text("Header 2 text", "header2") - #' card1$append_text("A paragraph of default text", "header2") + #' card1$append_text("A paragraph of default text") #' card1$append_plot( #' ggplot(iris, aes(x = Petal.Length)) + geom_histogram() #' ) @@ -40,7 +40,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter. #' card2 <- ReportCard$new() #' #' card2$append_text("Header 2 text", "header2") - #' card2$append_text("A paragraph of default text", "header2") + #' card2$append_text("A paragraph of default text") #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) #' table_res2 <- build_table(lyt, airquality) #' card2$append_table(table_res2) @@ -64,7 +64,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter. #' card1 <- ReportCard$new() #' #' card1$append_text("Header 2 text", "header2") - #' card1$append_text("A paragraph of default text", "header2") + #' card1$append_text("A paragraph of default text") #' card1$append_plot( #' ggplot(iris, aes(x = Petal.Length)) + geom_histogram() #' ) @@ -72,7 +72,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter. #' card2 <- ReportCard$new() #' #' card2$append_text("Header 2 text", "header2") - #' card2$append_text("A paragraph of default text", "header2") + #' card2$append_text("A paragraph of default text") #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) #' table_res2 <- build_table(lyt, airquality) #' card2$append_table(table_res2) @@ -96,7 +96,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter. #' card1 <- ReportCard$new() #' #' card1$append_text("Header 2 text", "header2") - #' card1$append_text("A paragraph of default text", "header2") + #' card1$append_text("A paragraph of default text") #' card1$append_plot( #' ggplot(iris, aes(x = Petal.Length)) + geom_histogram() #' ) @@ -104,7 +104,7 @@ Reporter <- R6::R6Class( # nolint: object_name_linter. #' card2 <- ReportCard$new() #' #' card2$append_text("Header 2 text", "header2") - #' card2$append_text("A paragraph of default text", "header2") + #' card2$append_text("A paragraph of default text") #' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) #' table_res2 <- build_table(lyt, airquality) #' card2$append_table(table_res2) diff --git a/man/Renderer.Rd b/man/Renderer.Rd index 247e7800..1bdd886c 100644 --- a/man/Renderer.Rd +++ b/man/Renderer.Rd @@ -27,7 +27,7 @@ ReportCard <- getFromNamespace("ReportCard", "teal.reporter") card2 <- ReportCard$new() card2$append_text("Header 2 text", "header2") -card2$append_text("A paragraph of default text", "header2") +card2$append_text("A paragraph of default text") lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) table_res2 <- build_table(lyt, airquality) card2$append_table(table_res2) @@ -68,7 +68,7 @@ ReportCard <- getFromNamespace("ReportCard", "teal.reporter") card2 <- ReportCard$new() card2$append_text("Header 2 text", "header2") -card2$append_text("A paragraph of default text", "header2") +card2$append_text("A paragraph of default text") lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) table_res2 <- build_table(lyt, airquality) card2$append_table(table_res2) diff --git a/man/Reporter.Rd b/man/Reporter.Rd index ee4af4b0..a45cced6 100644 --- a/man/Reporter.Rd +++ b/man/Reporter.Rd @@ -25,7 +25,7 @@ library(rtables) card1 <- ReportCard$new() card1$append_text("Header 2 text", "header2") -card1$append_text("A paragraph of default text", "header2") +card1$append_text("A paragraph of default text") card1$append_plot( ggplot(iris, aes(x = Petal.Length)) + geom_histogram() ) @@ -33,7 +33,7 @@ card1$append_plot( card2 <- ReportCard$new() card2$append_text("Header 2 text", "header2") -card2$append_text("A paragraph of default text", "header2") +card2$append_text("A paragraph of default text") lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) table_res2 <- build_table(lyt, airquality) card2$append_table(table_res2) @@ -49,7 +49,7 @@ library(rtables) card1 <- ReportCard$new() card1$append_text("Header 2 text", "header2") -card1$append_text("A paragraph of default text", "header2") +card1$append_text("A paragraph of default text") card1$append_plot( ggplot(iris, aes(x = Petal.Length)) + geom_histogram() ) @@ -57,7 +57,7 @@ card1$append_plot( card2 <- ReportCard$new() card2$append_text("Header 2 text", "header2") -card2$append_text("A paragraph of default text", "header2") +card2$append_text("A paragraph of default text") lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) table_res2 <- build_table(lyt, airquality) card2$append_table(table_res2) @@ -74,7 +74,7 @@ library(rtables) card1 <- ReportCard$new() card1$append_text("Header 2 text", "header2") -card1$append_text("A paragraph of default text", "header2") +card1$append_text("A paragraph of default text") card1$append_plot( ggplot(iris, aes(x = Petal.Length)) + geom_histogram() ) @@ -82,7 +82,7 @@ card1$append_plot( card2 <- ReportCard$new() card2$append_text("Header 2 text", "header2") -card2$append_text("A paragraph of default text", "header2") +card2$append_text("A paragraph of default text") lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean) table_res2 <- build_table(lyt, airquality) card2$append_table(table_res2) From 52cf6c8634571b2c9df1af18f083387a2eb9afc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Llu=C3=ADs=20Revilla?= Date: Tue, 21 Jan 2025 17:05:13 +0100 Subject: [PATCH 3/3] Update dependencies' versions --- DESCRIPTION | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index eaa804c9..bf9770e4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -32,8 +32,8 @@ Imports: R6, rlistings (>= 0.2.10), rmarkdown (>= 2.23), - rtables (>= 0.6.10.9004), - rtables.officer (>= 0.0.1.9005), + rtables (>= 0.6.11), + rtables.officer (>= 0.0.2), shiny (>= 1.6.0), shinybusy (>= 0.3.2), shinyWidgets (>= 0.5.1),