ReportCard: 'ReportCard': An 'R6' class for building report elements
In teal.reporter: Reporting Tools for 'shiny' Modules
ReportCard R Documentation
ReportCard: An R6 class for building report elements
Description
![[Experimental]](../help/figures/lifecycle-experimental.svg)
This R6 class that supports creating a report card containing text, plot, table and
metadata blocks that can be appended and rendered to form a report output from a shiny app.
For more information about the various blocks, refer to the vignette:
vignette("teal-reporter-blocks-overview", "teal.reporter").
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Method new()
Initialize a ReportCard object.
Usage
ReportCard$new()
Returns
Object of class ReportCard, invisibly.
Examples
card <- ReportCard$new()
Method append_table()
Appends a table to this ReportCard.
Usage
ReportCard$append_table(table)
Arguments
tableA (data.frame or rtables or TableTree or ElementaryTable or listing_df)
that can be coerced into a table.
Returns
self, invisibly.
Examples
card <- ReportCard$new()$append_table(iris)
Method append_html()
Appends a html content to this ReportCard.
Usage
ReportCard$append_html(content)
Arguments
contentAn object that can be rendered as a HTML content.
Returns
self, invisibly.
Examples
card <- ReportCard$new()$append_html(shiny::div("HTML Content"))
Method append_plot()
Appends a plot to this ReportCard.
Usage
ReportCard$append_plot(plot, dim = NULL)
Arguments
plot(ggplot or grob or trellis) plot object.
dim(numeric(2)) width and height in pixels.
Returns
self, invisibly.
Method append_text()
Appends a text paragraph to this ReportCard.
Usage
ReportCard$append_text(text, style = TextBlock$new()$get_available_styles()[1])
Arguments
text(character) The text content to add.
style(character(1)) the style of the paragraph. One of: default, header2, header3, verbatim.
Returns
self, invisibly.
Examples
card <- ReportCard$new()$append_text("A paragraph of default text")
Method append_rcode()
Appends an R code chunk to ReportCard.
Usage
ReportCard$append_rcode(text, ...)
Arguments
text(character) The R code to include.
...Additional rmarkdown parameters for formatting the R code chunk.
Returns
self, invisibly.
Examples
card <- ReportCard$new()$append_rcode("2+2", echo = FALSE)
Method append_content()
Appends a generic ContentBlock to this ReportCard.
Usage
ReportCard$append_content(content)
Arguments
content(ContentBlock) object.
Returns
self, invisibly.
Examples
NewpageBlock <- getFromNamespace("NewpageBlock", "teal.reporter")
card <- ReportCard$new()$append_content(NewpageBlock$new())
Method get_content()
Get all content blocks from this ReportCard.
Usage
ReportCard$get_content()
Returns
list() list of TableBlock, TextBlock and PictureBlock.
Examples
card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
card$get_content()
Method reset()
Clears all content and metadata from ReportCard.
Usage
ReportCard$reset()
Returns
self, invisibly.
Method get_metadata()
Get the metadata associated with ReportCard.
Usage
ReportCard$get_metadata()
Returns
named list list of elements.
Examples
card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
card$get_metadata()
Method append_metadata()
Appends metadata to this ReportCard.
Usage
ReportCard$append_metadata(key, value)
Arguments
key(character(1)) string specifying the metadata key.
valuevalue associated with the metadata key.
Returns
self, invisibly.
Method get_name()
Get the name of the ReportCard.
Usage
ReportCard$get_name()
Returns
character a card name.
Examples
ReportCard$new()$set_name("NAME")$get_name()
Method set_name()
Set the name of the ReportCard.
Usage
ReportCard$set_name(name)
Arguments
name(character(1)) a card name.
Returns
self, invisibly.
Examples
ReportCard$new()$set_name("NAME")$get_name()
Method to_list()
Convert the ReportCard to a list, including content and metadata.
Usage
ReportCard$to_list(output_dir)
Arguments
output_dir(character) with a path to the directory where files will be copied.
Returns
(named list) a ReportCard representation.
Method from_list()
Reconstructs the ReportCard from a list representation.
Usage
ReportCard$from_list(card, output_dir)
Arguments
card(named list) a ReportCard representation.
output_dir(character) with a path to the directory where a file will be copied.
Returns
self, invisibly.
Method clone()
The objects of this class are cloneable with this method.
Usage
ReportCard$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
library(ggplot2)
card <- ReportCard$new()$append_plot(
ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
)
library(ggplot2)
card <- ReportCard$new()$append_text("Some text")$append_plot(
ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
)$append_text("Some text")$append_metadata(key = "lm",
value = lm(Ozone ~ Solar.R, airquality))
card$get_content()
card$get_metadata()
library(ggplot2)
card <- ReportCard$new()$append_text("Some text")$append_plot(
ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
)$append_text("Some text")$append_metadata(key = "lm",
value = lm(Ozone ~ Solar.R, airquality))
card$get_content()
card$to_list(tempdir())
library(ggplot2)
card <- ReportCard$new()$append_text("Some text")$append_plot(
ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
)$append_text("Some text")$append_metadata(key = "lm",
value = lm(Ozone ~ Solar.R, airquality))
card$get_content()
ReportCard$new()$from_list(card$to_list(tempdir()), tempdir())
## ------------------------------------------------
## Method `ReportCard$new`
## ------------------------------------------------
card <- ReportCard$new()
## ------------------------------------------------
## Method `ReportCard$append_table`
## ------------------------------------------------
card <- ReportCard$new()$append_table(iris)
## ------------------------------------------------
## Method `ReportCard$append_html`
## ------------------------------------------------
card <- ReportCard$new()$append_html(shiny::div("HTML Content"))
## ------------------------------------------------
## Method `ReportCard$append_text`
## ------------------------------------------------
card <- ReportCard$new()$append_text("A paragraph of default text")
## ------------------------------------------------
## Method `ReportCard$append_rcode`
## ------------------------------------------------
card <- ReportCard$new()$append_rcode("2+2", echo = FALSE)
## ------------------------------------------------
## Method `ReportCard$append_content`
## ------------------------------------------------
NewpageBlock <- getFromNamespace("NewpageBlock", "teal.reporter")
card <- ReportCard$new()$append_content(NewpageBlock$new())
## ------------------------------------------------
## Method `ReportCard$get_content`
## ------------------------------------------------
card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
card$get_content()
## ------------------------------------------------
## Method `ReportCard$get_metadata`
## ------------------------------------------------
card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
card$get_metadata()
## ------------------------------------------------
## Method `ReportCard$get_name`
## ------------------------------------------------
ReportCard$new()$set_name("NAME")$get_name()
## ------------------------------------------------
## Method `ReportCard$set_name`
## ------------------------------------------------
ReportCard$new()$set_name("NAME")$get_name()
teal.reporter documentation built on April 3, 2025, 7:39 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| ReportCard | R Documentation |
ReportCard: An R6 class for building report elements
Description
This R6 class that supports creating a report card containing text, plot, table and
metadata blocks that can be appended and rendered to form a report output from a shiny app.
For more information about the various blocks, refer to the vignette:
vignette("teal-reporter-blocks-overview", "teal.reporter").
Methods
Public methods
Method new()
Initialize a ReportCard object.
Usage
ReportCard$new()
Returns
Object of class ReportCard, invisibly.
Examples
card <- ReportCard$new()
Method append_table()
Appends a table to this ReportCard.
Usage
ReportCard$append_table(table)
Arguments
tableA (
data.frameorrtablesorTableTreeorElementaryTableorlisting_df) that can be coerced into a table.
Returns
self, invisibly.
Examples
card <- ReportCard$new()$append_table(iris)
Method append_html()
Appends a html content to this ReportCard.
Usage
ReportCard$append_html(content)
Arguments
contentAn object that can be rendered as a HTML content.
Returns
self, invisibly.
Examples
card <- ReportCard$new()$append_html(shiny::div("HTML Content"))
Method append_plot()
Appends a plot to this ReportCard.
Usage
ReportCard$append_plot(plot, dim = NULL)
Arguments
plot(
ggplotorgrobortrellis) plot object.dim(
numeric(2)) width and height in pixels.
Returns
self, invisibly.
Method append_text()
Appends a text paragraph to this ReportCard.
Usage
ReportCard$append_text(text, style = TextBlock$new()$get_available_styles()[1])
Arguments
text(
character) The text content to add.style(
character(1)) the style of the paragraph. One of: default, header2, header3, verbatim.
Returns
self, invisibly.
Examples
card <- ReportCard$new()$append_text("A paragraph of default text")
Method append_rcode()
Appends an R code chunk to ReportCard.
Usage
ReportCard$append_rcode(text, ...)
Arguments
text(
character) TheRcode to include....Additional
rmarkdownparameters for formatting theRcode chunk.
Returns
self, invisibly.
Examples
card <- ReportCard$new()$append_rcode("2+2", echo = FALSE)
Method append_content()
Appends a generic ContentBlock to this ReportCard.
Usage
ReportCard$append_content(content)
Arguments
content(
ContentBlock) object.
Returns
self, invisibly.
Examples
NewpageBlock <- getFromNamespace("NewpageBlock", "teal.reporter")
card <- ReportCard$new()$append_content(NewpageBlock$new())
Method get_content()
Get all content blocks from this ReportCard.
Usage
ReportCard$get_content()
Returns
list() list of TableBlock, TextBlock and PictureBlock.
Examples
card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
card$get_content()
Method reset()
Clears all content and metadata from ReportCard.
Usage
ReportCard$reset()
Returns
self, invisibly.
Method get_metadata()
Get the metadata associated with ReportCard.
Usage
ReportCard$get_metadata()
Returns
named list list of elements.
Examples
card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
card$get_metadata()
Method append_metadata()
Appends metadata to this ReportCard.
Usage
ReportCard$append_metadata(key, value)
Arguments
key(
character(1)) string specifying the metadata key.valuevalue associated with the metadata key.
Returns
self, invisibly.
Method get_name()
Get the name of the ReportCard.
Usage
ReportCard$get_name()
Returns
character a card name.
Examples
ReportCard$new()$set_name("NAME")$get_name()
Method set_name()
Set the name of the ReportCard.
Usage
ReportCard$set_name(name)
Arguments
name(
character(1)) a card name.
Returns
self, invisibly.
Examples
ReportCard$new()$set_name("NAME")$get_name()
Method to_list()
Convert the ReportCard to a list, including content and metadata.
Usage
ReportCard$to_list(output_dir)
Arguments
output_dir(
character) with a path to the directory where files will be copied.
Returns
(named list) a ReportCard representation.
Method from_list()
Reconstructs the ReportCard from a list representation.
Usage
ReportCard$from_list(card, output_dir)
Arguments
card(
named list) aReportCardrepresentation.output_dir(
character) with a path to the directory where a file will be copied.
Returns
self, invisibly.
Method clone()
The objects of this class are cloneable with this method.
Usage
ReportCard$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
library(ggplot2)
card <- ReportCard$new()$append_plot(
ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
)
library(ggplot2)
card <- ReportCard$new()$append_text("Some text")$append_plot(
ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
)$append_text("Some text")$append_metadata(key = "lm",
value = lm(Ozone ~ Solar.R, airquality))
card$get_content()
card$get_metadata()
library(ggplot2)
card <- ReportCard$new()$append_text("Some text")$append_plot(
ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
)$append_text("Some text")$append_metadata(key = "lm",
value = lm(Ozone ~ Solar.R, airquality))
card$get_content()
card$to_list(tempdir())
library(ggplot2)
card <- ReportCard$new()$append_text("Some text")$append_plot(
ggplot(iris, aes(x = Petal.Length)) + geom_histogram()
)$append_text("Some text")$append_metadata(key = "lm",
value = lm(Ozone ~ Solar.R, airquality))
card$get_content()
ReportCard$new()$from_list(card$to_list(tempdir()), tempdir())
## ------------------------------------------------
## Method `ReportCard$new`
## ------------------------------------------------
card <- ReportCard$new()
## ------------------------------------------------
## Method `ReportCard$append_table`
## ------------------------------------------------
card <- ReportCard$new()$append_table(iris)
## ------------------------------------------------
## Method `ReportCard$append_html`
## ------------------------------------------------
card <- ReportCard$new()$append_html(shiny::div("HTML Content"))
## ------------------------------------------------
## Method `ReportCard$append_text`
## ------------------------------------------------
card <- ReportCard$new()$append_text("A paragraph of default text")
## ------------------------------------------------
## Method `ReportCard$append_rcode`
## ------------------------------------------------
card <- ReportCard$new()$append_rcode("2+2", echo = FALSE)
## ------------------------------------------------
## Method `ReportCard$append_content`
## ------------------------------------------------
NewpageBlock <- getFromNamespace("NewpageBlock", "teal.reporter")
card <- ReportCard$new()$append_content(NewpageBlock$new())
## ------------------------------------------------
## Method `ReportCard$get_content`
## ------------------------------------------------
card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
card$get_content()
## ------------------------------------------------
## Method `ReportCard$get_metadata`
## ------------------------------------------------
card <- ReportCard$new()$append_text("Some text")$append_metadata("rc", "a <- 2 + 2")
card$get_metadata()
## ------------------------------------------------
## Method `ReportCard$get_name`
## ------------------------------------------------
ReportCard$new()$set_name("NAME")$get_name()
## ------------------------------------------------
## Method `ReportCard$set_name`
## ------------------------------------------------
ReportCard$new()$set_name("NAME")$get_name()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.