Skip to contents

shiny modules for adding content to reports

shiny modules for viewing and downloading reports

Supporting shiny modules

download_report_button_ui() download_report_button_srv()
Download report button module
reset_report_button_ui() reset_report_button_srv()
Reset report button module
report_load_ui() report_load_srv()
Load Reporter button module
ui_editor_block() srv_editor_block()
UI and Server functions for editing report document blocks
add_card_button_ui() add_card_button_srv()
Add card button module
preview_report_button_ui() preview_report_button_srv() experimental
Show report previewer button module

yaml and rmd utility functions

as_yaml_auto()
Parse a named list to yaml header for an Rmd file
print(<rmd_yaml_header>)
Print method for the yaml_header class
rmd_output_arguments()
Get document output arguments from the rmarkdown package
rmd_outputs()
Get document output types from the rmarkdown package

Classes used inside package

teal_card() `teal_card<-`() as.teal_card() c(<teal_card>) `[`(<teal_card>) experimental
teal_card: An S3 class for managing teal reports
teal_report() as.teal_report() stable
Comprehensive data integration function for teal applications
ReportCard
ReportCard: An R6 class for building report elements
Reporter
Reporter: An R6 class for managing reports

Utility functions for teal_card object

teal_card() `teal_card<-`() as.teal_card() c(<teal_card>) `[`(<teal_card>) experimental
teal_card: An S3 class for managing teal reports
code_chunk()
Generate an R Markdown code chunk
metadata()
Access metadata from a teal_card or ReportCard
`metadata<-`()
Set metadata for a teal_card or ReportCard
render()
Render teal_card

Utility functions for teal_report object

c(<teal_report>)
Concatenate teal_report objects
eval_code(<teal_report>)
Evaluate code in qenv

Deprecated functions

reporter_previewer_ui() reporter_previewer_srv() deprecated
Report previewer module