Skip to content

Commit 4930f11

Browse files
authored
[skip vbump] upversion to 0.4.0 (#300)
Related to #296 * Update NEWS * Update DESCRIPTION and upversion rtables.office and rtables to released version
1 parent c678ca2 commit 4930f11

File tree

6 files changed

+35
-48
lines changed

6 files changed

+35
-48
lines changed

DESCRIPTION

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: teal.reporter
22
Title: Reporting Tools for 'shiny' Modules
3-
Version: 0.3.1.9024
3+
Version: 0.4.0
44
Date: 2025-01-22
55
Authors@R: c(
66
person("Dawid", "Kaledkowski", , "dawid.kaledkowski@roche.com", role = c("aut", "cre"),
@@ -54,8 +54,6 @@ VignetteBuilder:
5454
rmarkdown
5555
RdMacros:
5656
lifecycle
57-
Remotes:
58-
insightsengineering/rtables.officer
5957
Config/Needs/verdepcheck: rstudio/bslib, mllg/checkmate,
6058
davidgohel/flextable, rstudio/htmltools, yihui/knitr, r-lib/lifecycle,
6159
r-lib/R6, insightsengineering/rlistings, rstudio/rmarkdown,

NEWS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# teal.reporter 0.3.1.9024
1+
# teal.reporter 0.4.0
22

33
### Enhancements
44

5-
* Report cards are now included in bookmarks. When using the `shiny` bookmarking mechanism, present report cards will be available in the restored application.
6-
* Report can be loaded back now. The zip file with the report can be loaded back which will restore Previewer state.
5+
* Reports can now be reloaded. A zip file containing the report can be uploaded to restore the state of the Previewer.
6+
* Report cards are now included in bookmarks. When using the `shiny` bookmarking mechanism, existing report cards will be available in the restored application.
7+
* HTML content can now be added to the report.
78

89
# teal.reporter 0.3.1
910

R/Renderer.R

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,40 +44,38 @@ Renderer <- R6::R6Class( # nolint: object_name_linter.
4444
#' library(ggplot2)
4545
#'
4646
#' ReportCard <- getFromNamespace("ReportCard", "teal.reporter")
47-
#' card1 <- ReportCard$new()
47+
#' Reporter <- getFromNamespace("Reporter", "teal.reporter")
48+
#' yaml_quoted <- getFromNamespace("yaml_quoted", "teal.reporter")
49+
#' md_header <- getFromNamespace("md_header", "teal.reporter")
50+
#' Renderer <- getFromNamespace("Renderer", "teal.reporter")
4851
#'
52+
#' card1 <- ReportCard$new()
4953
#' card1$append_text("Header 2 text", "header2")
5054
#' card1$append_text("A paragraph of default text")
5155
#' card1$append_plot(
5256
#' ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
5357
#' )
5458
#'
55-
#' ReportCard <- getFromNamespace("ReportCard", "teal.reporter")
5659
#' card2 <- ReportCard$new()
57-
#'
5860
#' card2$append_text("Header 2 text", "header2")
5961
#' card2$append_text("A paragraph of default text")
6062
#' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
6163
#' table_res2 <- build_table(lyt, airquality)
6264
#' card2$append_table(table_res2)
63-
#' card2$append_table(iris)
6465
#' card2$append_rcode("2+2", echo = FALSE)
6566
#'
66-
#' Reporter <- getFromNamespace("Reporter", "teal.reporter")
6767
#' reporter <- Reporter$new()
6868
#' reporter$append_cards(list(card1, card2))
6969
#'
70-
#' yaml_quoted <- getFromNamespace("yaml_quoted", "teal.reporter")
7170
#' yaml_l <- list(
7271
#' author = yaml_quoted("NEST"),
7372
#' title = yaml_quoted("Report"),
7473
#' date = yaml_quoted("07/04/2019"),
7574
#' output = list(html_document = list(toc = FALSE))
7675
#' )
7776
#'
78-
#' md_header <- getFromNamespace("md_header", "teal.reporter")
7977
#' yaml_header <- md_header(as.yaml(yaml_l))
80-
#' Renderer <- getFromNamespace("Renderer", "teal.reporter")
78+
#'
8179
#' result_path <- Renderer$new()$renderRmd(reporter$get_blocks(), yaml_header)
8280
#'
8381
renderRmd = function(blocks, yaml_header, global_knitr = getOption("teal.reporter.global_knitr")) {
@@ -148,39 +146,38 @@ Renderer <- R6::R6Class( # nolint: object_name_linter.
148146
#' library(ggplot2)
149147
#'
150148
#' ReportCard <- getFromNamespace("ReportCard", "teal.reporter")
151-
#' card1 <- ReportCard$new()
149+
#' Reporter <- getFromNamespace("Reporter", "teal.reporter")
150+
#' yaml_quoted <- getFromNamespace("yaml_quoted", "teal.reporter")
151+
#' md_header <- getFromNamespace("md_header", "teal.reporter")
152+
#' Renderer <- getFromNamespace("Renderer", "teal.reporter")
152153
#'
154+
#' card1 <- ReportCard$new()
153155
#' card1$append_text("Header 2 text", "header2")
154156
#' card1$append_text("A paragraph of default text")
155157
#' card1$append_plot(
156158
#' ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
157159
#' )
158160
#'
159-
#' ReportCard <- getFromNamespace("ReportCard", "teal.reporter")
160161
#' card2 <- ReportCard$new()
161-
#'
162162
#' card2$append_text("Header 2 text", "header2")
163163
#' 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)
167-
#' card2$append_table(iris)
168167
#' card2$append_rcode("2+2", echo = FALSE)
169-
#' Reporter <- getFromNamespace("Reporter", "teal.reporter")$new()
170-
#' Reporter$append_cards(list(card1, card2))
171168
#'
172-
#' yaml_quoted <- getFromNamespace("yaml_quoted", "teal.reporter")
169+
#' reporter <- Reporter$new()
170+
#' reporter$append_cards(list(card1, card2))
171+
#'
173172
#' yaml_l <- list(
174173
#' author = yaml_quoted("NEST"),
175174
#' title = yaml_quoted("Report"),
176175
#' date = yaml_quoted("07/04/2019"),
177176
#' output = list(html_document = list(toc = FALSE))
178177
#' )
179178
#'
180-
#' md_header <- getFromNamespace("md_header", "teal.reporter")
181179
#' yaml_header <- md_header(as.yaml(yaml_l))
182-
#' Renderer <- getFromNamespace("Renderer", "teal.reporter")
183-
#' result_path <- Renderer$new()$render(Reporter$get_blocks(), yaml_header)
180+
#' result_path <- Renderer$new()$render(reporter$get_blocks(), yaml_header)
184181
#'
185182
render = function(blocks, yaml_header, global_knitr = getOption("teal.reporter.global_knitr"), ...) {
186183
args <- list(...)

R/Reporter.R

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
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)
47-
#' card2$append_table(iris)
4847
#'
4948
#' reporter <- Reporter$new()
5049
#' reporter$append_cards(list(card1, card2))
@@ -76,7 +75,6 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
7675
#' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
7776
#' table_res2 <- build_table(lyt, airquality)
7877
#' card2$append_table(table_res2)
79-
#' card2$append_table(iris)
8078
#'
8179
#' reporter <- Reporter$new()
8280
#' reporter$append_cards(list(card1, card2))
@@ -108,7 +106,6 @@ Reporter <- R6::R6Class( # nolint: object_name_linter.
108106
#' lyt <- analyze(split_rows_by(basic_table(), "Day"), "Ozone", afun = mean)
109107
#' table_res2 <- build_table(lyt, airquality)
110108
#' card2$append_table(table_res2)
111-
#' card2$append_table(iris)
112109
#'
113110
#' reporter <- Reporter$new()
114111
#' reporter$append_cards(list(card1, card2))

man/Renderer.Rd

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

man/Reporter.Rd

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

0 commit comments

Comments
 (0)