Package index • teal

Core `teal` functions

Main functions needed to build a teal app

init(): Create the server and UI function for the shiny app

teal_data_module() eval_code(<teal_data_module>,<character>) within(<teal_data_module>) experimental: Data module for teal applications

teal_transform_module() experimental: Data module for teal transformations and output customization

ui_transform_teal_data() srv_transform_teal_data(): Module to transform reactive teal_data

make_teal_transform_server(): Make teal_transform_module's server

ui_teal_with_splash() srv_teal_with_splash() deprecated: UI and server modules of teal

ui_teal() srv_teal(): teal main module

ui_session_info() srv_session_info(): teal user session info module

module() modules() format(<teal_module>) format(<teal_modules>) print(<teal_module>) print(<teal_modules>): Create teal_module and teal_modules objects

teal_slices() as.teal_slices() c(<teal_slices>): Filter settings for teal applications

Application modifiers for `teal`

Functions to modify the teal app object

modify_title() modify_header() modify_footer(): Replace UI Elements in teal UI objects

add_landing_modal(): Add a Landing Popup to teal Application

Helper Functions

Helper functions for teal

build_app_title(): Build app title with favicon

Example module

A simple teal module

example_module(): An example teal module

Creating reports

reporter_previewer_module() deprecated: Create a teal module for previewing a report

TealReportCard experimental: TealReportCard

report_card_template(): Template function for TealReportCard creation and customization

landing_popup_module() deprecated: Landing popup module

Functions for module developers

new_tdata() tdata2env() get_code_tdata() join_keys(<tdata>) get_metadata() as_tdata() superseded: Create a tdata object

teal_data_module() eval_code(<teal_data_module>,<character>) within(<teal_data_module>) experimental: Data module for teal applications

show_rcode_modal() deprecated: Show R code modal

Validation functions

validate_has_data(): Validate that dataset has a minimum number of observations

validate_has_elements(): Validates that vector has length greater than 0

validate_has_variable(): Validates that dataset contains specific variable

validate_in(): Validates that vector includes all expected values

validate_inputs(): Send input validation messages to output

validate_n_levels(): Validate that variables has expected number of levels

validate_no_intersection(): Validates no intersection between two vectors

validate_one_row_per_id(): Validate that dataset has unique rows for key variables