teal.bs_theme (bslib::bs_theme object)

This option controls the bootstrap theme and version used in teal apps. Achieve better UX with the customized UI of an app. Please see the vignette on Bootstrap themes to read more about the functionality.

Default: bslib::bs_theme()

teal.load_nest_code (character)

The value of this option is appended to the top of the code rendered when using the Show R Code modal button.

Default: "# Add any code to install/load your NEST environment here".

teal.threshold_slider_vs_checkboxgroup (numeric)

This is the threshold that determines if a variable is treated as a factor in the filter panel. If the number of unique values of a variable is less than this threshold the variable will be treated as a factor instead of its original class. As an example, imagine teal.threshold_slider_vs_checkboxgroup equals to 2. Then a numeric variable c(1, 1, 1), which has only one unique value, is treated as a factor in the filter panel (and in the filter panel only!). The filter panel creates a checkbox widget to filter values from this variable, as it would for a factor variable, instead of the usual numeric range selector.

Default: 5.

teal.basic_table_args (basic_table_args object)

This specifies the list of arguments passed to every call to rtables::basic_table made in a teal application. This can be used to format rtables without making any changes to the application code. See the documentation of teal.widgets::basic_table_args for more information.

Default: teal.widgets::basic_table_args().

teal.ggplot2_args (ggplot2_args object)

This option allows modifying labels and themes of all ggplot2 plots in a teal application. See the documentation of teal.widgets::ggplot2_args for more information.

Default: teal.widgets::ggplot2_args().

teal.plot_dpi (integer value 24 or larger)

This option controls the dots per inch of the graphs rendered and downloaded when using the module plot_with_settings from the teal.widgets package.

Default: 72

teal.log_layout (character)

This defines the layout of a log message used in a teal application. teal uses this layout to format the emitted log messages. Read the documentation of teal.logger::register_logger for more information. This must be set before loading any teal package(s). In case the option is set after attaching the packages, please re-attach the packages again to use it correctly.

Default: "[{level}] {format(time, \"%Y-%m-%d %H:%M:%OS4\")} pid:{pid} token:[{token}] {ans} {msg}".

Note that this layout is formatted by the glue package.

teal.log_level (character)

This is the logging level threshold used in a teal application. A teal application will not emit logs below this level. See the documentation of logger::TRACE for all possible values of logging threshold and more information on what it does. This must be set before loading any teal package(s). In case the option is set after attaching the packages, please re-attach the packages again to use it correctly.

Default: "INFO".

Note that there are two levels considered less severe than "INFO": "DEBUG" and "TRACE". In order to see the log messages for these two levels as well, change the log level from the default to "TRACE", the least severe log level.

teal.show_js_log (logical)

This indicates whether to print the JavaScript console logs to the R console. If set to TRUE, the logs will be printed; otherwise, they won’t.

Default: FALSE.

teal.lockfile.mode (character)

This enables to compute renv lockfile and shows a button to "download lockfile" in the footer.

Values:

• "auto" - auto detect whether to compute lockfile
• "enabled" - compute lockfile and show "download lockfile" in the footer
• "disabled" - do not compute lockfile and do not show "download lockfile" in the footer

Default: "auto".

To read more about lockfile usage creation check ?teal::module_teal_lockfile.

teal.sidebar.width (numeric)

This sets the sidebar width in pixels in the teal app.

Default: 250

teal.reporter.nav_buttons (character)

This option controls which of the four reporter navigation buttons (Preview Report, Download Report, Load Report, and Reset Report) should be displayed.

Default: c("preview", "download", "load", "reset").

teal.reporter.rmd_output (character)

This option allows customizing the R Markdown output types when a report is downloaded. It should be a subset of “html_document”, “pdf_document”, “powerpoint_presentation”, “word_document”.

Default:

c(
  "html" = "html_document", "pdf" = "pdf_document",
  "powerpoint" = "powerpoint_presentation",
  "word" = "word_document"
)

teal.reporter.rmd_yaml_args (character)

It allows customizing the R Markdown YAML arguments for the report. It should be a named vector and the names should be a subset of the supported YAML args: “author”, “title”, “date”, “output”, “toc”.

Default:

list(
  author = "NEST",
  title = "Report",
  date = as.character(Sys.Date()),
  output = "html_document",
  toc = FALSE
)

teal.reporter.global_knitr (list)

It allows customizing the global knitr parameters which are passed to knitr::opts_chunk$set for customizing the rendering process.

Default:

list(
  echo = TRUE,
  tidy.opts = list(width.cutoff = 60),
  tidy = requireNamespace("formatR", quietly = TRUE)
)

teal_logging

Deprecated in favor of using the teal.logger package for logging.

teal_show_js_log

Deprecated in favor of teal.show_js_log (see above).