Skip to content

Commit e4b0145

Browse files
authored
Match code and documentation (#299)
While checking for other issues I noticed in the examples some mismatch between the text and the result. I also observed some differences between the options on the code and the documented options. While checking the package I saw: ``` ─ checking examples ... [22s] OK (23.2s) Examples with CPU (user + system) or elapsed time > 5s user system elapsed Reporter 2.61 0.14 7.09 Renderer 2.30 0.30 7.74 ``` The problem might come from each method creating a new card and reporter, see r-lib/roxygen2#1521 for the underlying issue and linked issues here.
1 parent 5c18d08 commit e4b0145

File tree

7 files changed

+20
-20
lines changed

7 files changed

+20
-20
lines changed

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Imports:
3232
R6,
3333
rlistings (>= 0.2.10),
3434
rmarkdown (>= 2.23),
35-
rtables (>= 0.6.10.9004),
36-
rtables.officer (>= 0.0.1.9005),
35+
rtables (>= 0.6.11),
36+
rtables.officer (>= 0.0.2),
3737
shiny (>= 1.6.0),
3838
shinybusy (>= 0.3.2),
3939
shinyWidgets (>= 0.5.1),

R/Renderer.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Renderer <- R6::R6Class( # nolint: object_name_linter.
5656
#' card2 <- ReportCard$new()
5757
#'
5858
#' card2$append_text("Header 2 text", "header2")
59-
#' card2$append_text("A paragraph of default text", "header2")
59+
#' card2$append_text("A paragraph of default text")
6060
#' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
6161
#' table_res2 <- build_table(lyt, airquality)
6262
#' card2$append_table(table_res2)
@@ -160,7 +160,7 @@ Renderer <- R6::R6Class( # nolint: object_name_linter.
160160
#' card2 <- ReportCard$new()
161161
#'
162162
#' card2$append_text("Header 2 text", "header2")
163-
#' card2$append_text("A paragraph of default text", "header2")
163+
#' card2$append_text("A paragraph of default text")
164164
#' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
165165
#' table_res2 <- build_table(lyt, airquality)
166166
#' card2$append_table(table_res2)

R/ReportCard.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ ReportCard <- R6::R6Class( # nolint: object_name_linter.
7272
#' @description Appends a text paragraph to this `ReportCard`.
7373
#'
7474
#' @param text (`character`) The text content to add.
75-
#' @param style (`character(1)`) the style of the paragraph. One of: `default`, `header`, `verbatim`
75+
#' @param style (`character(1)`) the style of the paragraph. One of: `r TextBlock$new()$get_available_styles()`.
7676
#' @return `self`, invisibly.
7777
#' @examples
7878
#' card <- ReportCard$new()$append_text("A paragraph of default text")

R/Reporter.R

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
3232
#' card1 <- ReportCard$new()
3333
#'
3434
#' card1$append_text("Header 2 text", "header2")
35-
#' card1$append_text("A paragraph of default text", "header2")
35+
#' card1$append_text("A paragraph of default text")
3636
#' card1$append_plot(
3737
#' ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
3838
#' )
3939
#'
4040
#' card2 <- ReportCard$new()
4141
#'
4242
#' card2$append_text("Header 2 text", "header2")
43-
#' card2$append_text("A paragraph of default text", "header2")
43+
#' card2$append_text("A paragraph of default text")
4444
#' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
4545
#' table_res2 <- build_table(lyt, airquality)
4646
#' card2$append_table(table_res2)
@@ -64,15 +64,15 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
6464
#' card1 <- ReportCard$new()
6565
#'
6666
#' card1$append_text("Header 2 text", "header2")
67-
#' card1$append_text("A paragraph of default text", "header2")
67+
#' card1$append_text("A paragraph of default text")
6868
#' card1$append_plot(
6969
#' ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
7070
#' )
7171
#'
7272
#' card2 <- ReportCard$new()
7373
#'
7474
#' card2$append_text("Header 2 text", "header2")
75-
#' card2$append_text("A paragraph of default text", "header2")
75+
#' card2$append_text("A paragraph of default text")
7676
#' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
7777
#' table_res2 <- build_table(lyt, airquality)
7878
#' card2$append_table(table_res2)
@@ -96,15 +96,15 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
9696
#' card1 <- ReportCard$new()
9797
#'
9898
#' card1$append_text("Header 2 text", "header2")
99-
#' card1$append_text("A paragraph of default text", "header2")
99+
#' card1$append_text("A paragraph of default text")
100100
#' card1$append_plot(
101101
#' ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
102102
#' )
103103
#'
104104
#' card2 <- ReportCard$new()
105105
#'
106106
#' card2$append_text("Header 2 text", "header2")
107-
#' card2$append_text("A paragraph of default text", "header2")
107+
#' card2$append_text("A paragraph of default text")
108108
#' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
109109
#' table_res2 <- build_table(lyt, airquality)
110110
#' card2$append_table(table_res2)

man/Renderer.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/ReportCard.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/Reporter.Rd

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)