Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Match code and documentation #299

Merged
merged 3 commits into from
Jan 22, 2025
Merged

Match code and documentation #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7acb64
Make sure the docs are consistent with the code.
llrs-roche Jan 21, 2025
15a4cca
Match between text and code in the examples
llrs-roche Jan 21, 2025
52cf6c8
Update dependencies' versions
llrs-roche Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
4 changes: 2 additions & 2 deletions R/Renderer.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion R/ReportCard.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
12 changes: 6 additions & 6 deletions R/Reporter.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ 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()
#' )
#'
#' 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)
Expand All @@ -64,15 +64,15 @@ 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()
#' )
#'
#' 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)
Expand All @@ -96,15 +96,15 @@ 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()
#' )
#'
#' 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)
Expand Down
4 changes: 2 additions & 2 deletions man/Renderer.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ReportCard.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions man/Reporter.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading