Skip to contents

TealReportCard

TealReportCard.Rd

[Experimental] A child of ReportCard that is used for teal specific applications. In addition to the parent methods, it supports rendering teal specific elements such as the source code, the encodings panel content and the filter panel content as part of the meta data.

Super class

teal.reporter::ReportCard -> TealReportCard

Methods

Public methods

Inherited methods

Method append_src()

Appends the source code to the content meta data of this TealReportCard.

Usage 

TealReportCard$append_src(src, ...)

Arguments

src

(character(1)) code as text.

...

any rmarkdown R chunk parameter and its value. But eval parameter is always set to FALSE.

Returns

invisibly self

Examples 

card <- TealReportCard$new()$append_src(
  "plot(iris)"
)
card$get_content()[[1]]$get_content()

Method append_fs()

Appends the filter state list to the content and metadata of this TealReportCard. If the filter state list has an attribute named formatted, it appends it to the card otherwise it uses the default yaml::as.yaml to format the list. If the filter state list is empty, nothing is appended to the content.

Usage 

TealReportCard$append_fs(fs)

Arguments

fs

(teal_slices) object returned from teal_slices() function.

Returns

invisibly self

Method append_encodings()

Appends the encodings list to the content and metadata of this TealReportCard.

Usage 

TealReportCard$append_encodings(encodings)

Arguments

encodings

(list) list of encodings selections of the teal app.

Returns

invisibly self

Examples 

card <- TealReportCard$new()$append_encodings(list(variable1 = "X"))
card$get_content()[[1]]$get_content()

Method clone()

The objects of this class are cloneable with this method.

Usage 

TealReportCard$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples 


## ------------------------------------------------
## Method `TealReportCard$append_src`
## ------------------------------------------------

card <- TealReportCard$new()$append_src(
  "plot(iris)"
)
card$get_content()[[1]]$get_content()
#> [1] "plot(iris)"

## ------------------------------------------------
## Method `TealReportCard$append_encodings`
## ------------------------------------------------

card <- TealReportCard$new()$append_encodings(list(variable1 = "X"))
card$get_content()[[1]]$get_content()
#> [1] "Selected Options"