Skip to contents

[Stable]

Initializes a reportable data for teal application.

Usage

teal_report(
  ...,
  teal_card = NULL,
  code = character(0),
  join_keys = teal.data::join_keys()
)

as.teal_report(x)

Arguments

...

any number of objects (presumably data objects) provided as name = value pairs.

teal_card

(teal_card) object containing the report content.

code

(character, language) optional code to reproduce the datasets provided in .... Note this code is not executed and the teal_data may not be reproducible

Use verify() to verify code reproducibility.

join_keys

(join_keys or single join_key_set) optional object with datasets column names used for joining. If empty then no joins between pairs of objects.

x

(qenv or teal_data) object to convert to teal_report.

Value

A teal_report object.

Examples

teal_report(x1 = iris, x2 = mtcars)
#> ✖ code unverified
#> <environment: 0x5629271ecba0> 🔒 
#> Parent: <environment: package:yaml> 
#> Bindings:
#> - x1: [data.frame]
#> - x2: [data.frame]