TealAppDriver: Drive a 'teal' application
In teal: Exploratory Web Apps for Analyzing Clinical Trials Data
TealAppDriver R Documentation
Drive a teal application
Description
Extension of the shinytest2::AppDriver class with methods for
driving a teal application for performing interactions for shinytest2 tests.
Super class
shinytest2::AppDriver -> TealAppDriver
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Inherited methods
shinytest2::AppDriver$expect_download()shinytest2::AppDriver$expect_html()shinytest2::AppDriver$expect_js()shinytest2::AppDriver$expect_screenshot()shinytest2::AppDriver$expect_text()shinytest2::AppDriver$expect_unique_names()shinytest2::AppDriver$expect_values()shinytest2::AppDriver$get_chromote_session()shinytest2::AppDriver$get_dir()shinytest2::AppDriver$get_download()shinytest2::AppDriver$get_html()shinytest2::AppDriver$get_js()shinytest2::AppDriver$get_logs()shinytest2::AppDriver$get_screenshot()shinytest2::AppDriver$get_text()shinytest2::AppDriver$get_url()shinytest2::AppDriver$get_value()shinytest2::AppDriver$get_values()shinytest2::AppDriver$get_variant()shinytest2::AppDriver$get_window_size()shinytest2::AppDriver$log_message()shinytest2::AppDriver$run_js()shinytest2::AppDriver$set_inputs()shinytest2::AppDriver$set_window_size()shinytest2::AppDriver$upload_file()shinytest2::AppDriver$view()shinytest2::AppDriver$wait_for_idle()shinytest2::AppDriver$wait_for_js()shinytest2::AppDriver$wait_for_value()
TealAppDriver$new()
Initialize a TealAppDriver object for testing a teal application.
Usage
TealAppDriver$new(
app,
options = list(),
teal_options = list(),
timeout = rlang::missing_arg(),
load_timeout = rlang::missing_arg(),
...
)
Arguments
app(teal_app)
options(list) passed to shinyApp(options). See shiny::shinyApp().
teal_options(list) named list of R options to set inside the spawned
Shiny process (e.g. list(teal.enable_deep_linking = TRUE)). Applied at session
start so option-gated server logic sees them.
timeout(numeric) Default number of milliseconds for any timeout or
timeout_ parameter in the TealAppDriver class.
Defaults to 20s.
See shinytest2::AppDriver new method for more details on how to change it
via options or environment variables.
load_timeout(numeric) How long to wait for the app to load, in ms.
This includes the time to start R. Defaults to 100s.
See shinytest2::AppDriver new method for more details on how to change it
via options or environment variables
...Additional arguments to be passed to shinytest2::AppDriver$new
Returns
Object of class TealAppDriver
TealAppDriver$stop()
Extension of the parent shinytest2::AppDriver stop method that prints the logs
if the ACTIONS_STEP_DEBUG environment variable is set to true (case of value is ignored).
Usage
TealAppDriver$stop(...)
Arguments
...arguments passed to parent shinytest2::AppDriver click() method.
TealAppDriver$click()
Append parent shinytest2::AppDriver click method with a call to waif_for_idle() method.
Usage
TealAppDriver$click(...)
Arguments
...arguments passed to parent shinytest2::AppDriver click() method.
TealAppDriver$expect_no_shiny_error()
Check if the app has shiny errors. This checks for global shiny errors.
Note that any shiny errors dependent on shiny server render will only be captured after the teal module tab
is visited because shiny will not trigger server computations when the tab is invisible.
So, navigate to the module tab you want to test before calling this function.
Although, this catches errors hidden in the other module tabs if they are already rendered.
Usage
TealAppDriver$expect_no_shiny_error()
TealAppDriver$expect_no_validation_error()
Check if the app has no validation errors. This checks for global shiny validation errors.
Usage
TealAppDriver$expect_no_validation_error()
TealAppDriver$expect_validation_error()
Check if the app has validation errors. This checks for global shiny validation errors.
Usage
TealAppDriver$expect_validation_error()
TealAppDriver$set_input()
Set the input in the teal app.
Usage
TealAppDriver$set_input(input_id, value, ...)
Arguments
input_id(character) The shiny input id with it's complete name space.
valueThe value to set the input to.
...Additional arguments to be passed to shinytest2::AppDriver$set_inputs
Returns
The TealAppDriver object invisibly.
TealAppDriver$navigate_teal_tab()
Navigate the teal tabs in the teal app.
Usage
TealAppDriver$navigate_teal_tab(tab)
Arguments
tab(character) Labels of tabs to navigate to.
Note: Make sure to provide unique labels for the tabs.
Returns
The TealAppDriver object invisibly.
TealAppDriver$namespaces()
NS in different sections of teal app
Usage
TealAppDriver$namespaces(is_selector = FALSE)
Arguments
is_selector(logical(1)) whether ns function should prefix with #.
Returns
list of ns.
TealAppDriver$get_active_module_input()
Get the input from the module in the teal app.
This function will only access inputs from the name space of the current active teal module.
Usage
TealAppDriver$get_active_module_input(input_id)
Arguments
input_id(character) The shiny input id to get the value from.
Returns
The value of the shiny input.
TealAppDriver$get_active_module_output()
Get the output from the module in the teal app.
This function will only access outputs from the name space of the current active teal module.
Usage
TealAppDriver$get_active_module_output(output_id)
Arguments
output_id(character) The shiny output id to get the value from.
Returns
The value of the shiny output.
TealAppDriver$get_active_module_table_output()
Get the output from the module's teal.widgets::table_with_settings or DT::DTOutput in the teal app.
This function will only access outputs from the name space of the current active teal module.
Usage
TealAppDriver$get_active_module_table_output(table_id, which = 1)
Arguments
table_id(character(1)) The id of the table in the active teal module's name space.
which(integer) If there is more than one table, which should be extracted.
By default it will look for a table that is built using teal.widgets::table_with_settings.
Returns
The data.frame with table contents.
TealAppDriver$get_active_module_plot_output()
Get the output from the module's teal.widgets::plot_with_settings in the teal app.
This function will only access plots from the name space of the current active teal module.
Usage
TealAppDriver$get_active_module_plot_output(plot_id)
Arguments
plot_id(character(1)) The id of the plot in the active teal module's name space.
Returns
The src attribute as character(1) vector.
TealAppDriver$set_active_module_input()
Set the input in the module in the teal app.
This function will only set inputs in the name space of the current active teal module.
Usage
TealAppDriver$set_active_module_input(input_id, value, ...)
Arguments
input_id(character) The shiny input id to get the value from.
valueThe value to set the input to.
...Additional arguments to be passed to shinytest2::AppDriver$set_inputs
Returns
The TealAppDriver object invisibly.
TealAppDriver$get_active_filter_vars()
Get the active datasets that can be accessed via the filter panel of the current active teal module.
Usage
TealAppDriver$get_active_filter_vars()
TealAppDriver$get_active_data_summary_table()
Get the active data summary table
Usage
TealAppDriver$get_active_data_summary_table()
Returns
data.frame
TealAppDriver$is_visible()
Test if DOM elements are visible on the page with a JavaScript call.
Usage
TealAppDriver$is_visible(
selector,
content_visibility_auto = FALSE,
opacity_property = FALSE,
visibility_property = FALSE
)
Arguments
selector(character(1)) CSS selector to check visibility.
A CSS id will return only one element if the UI is well formed.
content_visibility_auto, opacity_property, visibility_property(logical(1)) See more information
on https://developer.mozilla.org/en-US/docs/Web/API/Element/checkVisibility.
Returns
Logical vector with all occurrences of the selector.
TealAppDriver$expect_visible()
Expect that DOM elements are visible on the page with a JavaScript call.
Usage
TealAppDriver$expect_visible(
selector,
content_visibility_auto = FALSE,
opacity_property = FALSE,
visibility_property = FALSE,
timeout
)
Arguments
selector(character(1)) CSS selector to check visibility.
if more than one element is found, at least one must be visible for this expectation to
be successful.
content_visibility_auto, opacity_property, visibility_property(logical(1))
See more information on https://developer.mozilla.org/en-US/docs/Web/API/Element/checkVisibility.
timeout(numeric(1)) Time in milliseconds to wait for the expectation to be met.
Defaults to the timeout parameter set during initialization of the TealAppDriver object.
TealAppDriver$expect_hidden()
Expect that DOM elements are hidden on the page with a JavaScript call.
Usage
TealAppDriver$expect_hidden(
selector,
content_visibility_auto = FALSE,
opacity_property = FALSE,
visibility_property = FALSE,
timeout
)
Arguments
selector(character(1)) CSS selector to check visibility.
if more than one element is found, all of them must be invisible for this expectation to
be successful.
content_visibility_auto, opacity_property, visibility_property(logical(1))
See more information on https://developer.mozilla.org/en-US/docs/Web/API/Element/checkVisibility.
timeout(numeric(1)) Time in milliseconds to wait for the expectation to be met.
Defaults to the timeout parameter set during initialization of the TealAppDriver object.
TealAppDriver$get_active_data_filters()
Get the active filter variables from a dataset in the teal app.
Usage
TealAppDriver$get_active_data_filters(dataset_name = NULL)
Arguments
dataset_name(character) The name of the dataset to get the filter variables from.
If NULL, the filter variables for all the datasets will be returned in a list.
TealAppDriver$add_filter_var()
Add a new variable from the dataset to be filtered.
Usage
TealAppDriver$add_filter_var(dataset_name, var_name, ...)
Arguments
dataset_name(character) The name of the dataset to add the filter variable to.
var_name(character) The name of the variable to add to the filter panel.
...Additional arguments to be passed to shinytest2::AppDriver$set_inputs
Returns
The TealAppDriver object invisibly.
TealAppDriver$remove_filter_var()
Remove an active filter variable of a dataset from the active filter variables panel.
Usage
TealAppDriver$remove_filter_var(dataset_name = NULL, var_name = NULL)
Arguments
dataset_name(character) The name of the dataset to remove the filter variable from.
If NULL, all the filter variables will be removed.
var_name(character) The name of the variable to remove from the filter panel.
If NULL, all the filter variables of the dataset will be removed.
Returns
The TealAppDriver object invisibly.
TealAppDriver$set_active_filter_selection()
Set the active filter values for a variable of a dataset in the active filter variable panel.
Usage
TealAppDriver$set_active_filter_selection(dataset_name, var_name, input, ...)
Arguments
dataset_name(character) The name of the dataset to set the filter value for.
var_name(character) The name of the variable to set the filter value for.
inputThe value to set the filter to.
...Additional arguments to be passed to shinytest2::AppDriver$set_inputs
Returns
The TealAppDriver object invisibly.
TealAppDriver$get_attr()
Extract html attribute (found by a selector).
Usage
TealAppDriver$get_attr(selector, attribute)
Arguments
selector(character(1)) specifying the selector to be used to get the content of a specific node.
attribute(character(1)) name of an attribute to retrieve from a node specified by selector.
Returns
The character vector.
TealAppDriver$get_html_rvest()
Wrapper around get_html that passes the output directly to rvest::read_html.
Usage
TealAppDriver$get_html_rvest(selector)
Arguments
selector(character(1)) passed to get_html.
Returns
An XML document.
Wrapper around get_url() method that opens the app in the browser.
TealAppDriver$open_url()
Usage
TealAppDriver$open_url()
Returns
Nothing. Opens the underlying teal app in the browser.
TealAppDriver$wait_for_active_module_value()
Waits until a specified input, output, or export value.
This function serves as a wrapper around the wait_for_value method,
providing a more flexible interface for waiting on different types of values within the active module namespace.
Usage
TealAppDriver$wait_for_active_module_value(
input = rlang::missing_arg(),
output = rlang::missing_arg(),
export = rlang::missing_arg(),
...
)
Arguments
input, output, exportA name of an input, output, or export value.
Only one of these parameters may be used.
...Must be empty. Allows for parameter expansion.
Parameter with additional value to passed in wait_for_value.
teal documentation built on June 30, 2026, 5:11 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| TealAppDriver | R Documentation |
Drive a teal application
Description
Extension of the shinytest2::AppDriver class with methods for
driving a teal application for performing interactions for shinytest2 tests.
Super class
shinytest2::AppDriver -> TealAppDriver
Methods
Public methods
Inherited methods
shinytest2::AppDriver$expect_download()shinytest2::AppDriver$expect_html()shinytest2::AppDriver$expect_js()shinytest2::AppDriver$expect_screenshot()shinytest2::AppDriver$expect_text()shinytest2::AppDriver$expect_unique_names()shinytest2::AppDriver$expect_values()shinytest2::AppDriver$get_chromote_session()shinytest2::AppDriver$get_dir()shinytest2::AppDriver$get_download()shinytest2::AppDriver$get_html()shinytest2::AppDriver$get_js()shinytest2::AppDriver$get_logs()shinytest2::AppDriver$get_screenshot()shinytest2::AppDriver$get_text()shinytest2::AppDriver$get_url()shinytest2::AppDriver$get_value()shinytest2::AppDriver$get_values()shinytest2::AppDriver$get_variant()shinytest2::AppDriver$get_window_size()shinytest2::AppDriver$log_message()shinytest2::AppDriver$run_js()shinytest2::AppDriver$set_inputs()shinytest2::AppDriver$set_window_size()shinytest2::AppDriver$upload_file()shinytest2::AppDriver$view()shinytest2::AppDriver$wait_for_idle()shinytest2::AppDriver$wait_for_js()shinytest2::AppDriver$wait_for_value()
TealAppDriver$new()
Initialize a TealAppDriver object for testing a teal application.
Usage
TealAppDriver$new( app, options = list(), teal_options = list(), timeout = rlang::missing_arg(), load_timeout = rlang::missing_arg(), ... )
Arguments
app(
teal_app)options(
list) passed toshinyApp(options). Seeshiny::shinyApp().teal_options(
list) named list of R options to set inside the spawned Shiny process (e.g.list(teal.enable_deep_linking = TRUE)). Applied at session start so option-gated server logic sees them.timeout(
numeric) Default number of milliseconds for any timeout or timeout_ parameter in theTealAppDriverclass. Defaults to 20s.See
shinytest2::AppDrivernewmethod for more details on how to change it via options or environment variables.load_timeout(
numeric) How long to wait for the app to load, in ms. This includes the time to start R. Defaults to 100s.See
shinytest2::AppDrivernewmethod for more details on how to change it via options or environment variables...Additional arguments to be passed to
shinytest2::AppDriver$new
Returns
Object of class TealAppDriver
TealAppDriver$stop()
Extension of the parent shinytest2::AppDriver stop method that prints the logs
if the ACTIONS_STEP_DEBUG environment variable is set to true (case of value is ignored).
Usage
TealAppDriver$stop(...)
Arguments
...arguments passed to parent
shinytest2::AppDriverclick()method.
TealAppDriver$click()
Append parent shinytest2::AppDriver click method with a call to waif_for_idle() method.
Usage
TealAppDriver$click(...)
Arguments
...arguments passed to parent
shinytest2::AppDriverclick()method.
TealAppDriver$expect_no_shiny_error()
Check if the app has shiny errors. This checks for global shiny errors. Note that any shiny errors dependent on shiny server render will only be captured after the teal module tab is visited because shiny will not trigger server computations when the tab is invisible. So, navigate to the module tab you want to test before calling this function. Although, this catches errors hidden in the other module tabs if they are already rendered.
Usage
TealAppDriver$expect_no_shiny_error()
TealAppDriver$expect_no_validation_error()
Check if the app has no validation errors. This checks for global shiny validation errors.
Usage
TealAppDriver$expect_no_validation_error()
TealAppDriver$expect_validation_error()
Check if the app has validation errors. This checks for global shiny validation errors.
Usage
TealAppDriver$expect_validation_error()
TealAppDriver$set_input()
Set the input in the teal app.
Usage
TealAppDriver$set_input(input_id, value, ...)
Arguments
input_id(character) The shiny input id with it's complete name space.
valueThe value to set the input to.
...Additional arguments to be passed to
shinytest2::AppDriver$set_inputs
Returns
The TealAppDriver object invisibly.
TealAppDriver$navigate_teal_tab()
Navigate the teal tabs in the teal app.
Usage
TealAppDriver$navigate_teal_tab(tab)
Arguments
tab(character) Labels of tabs to navigate to. Note: Make sure to provide unique labels for the tabs.
Returns
The TealAppDriver object invisibly.
TealAppDriver$namespaces()
NS in different sections of teal app
Usage
TealAppDriver$namespaces(is_selector = FALSE)
Arguments
is_selector(
logical(1)) whethernsfunction should prefix with#.
Returns
list of ns.
TealAppDriver$get_active_module_input()
Get the input from the module in the teal app.
This function will only access inputs from the name space of the current active teal module.
Usage
TealAppDriver$get_active_module_input(input_id)
Arguments
input_id(character) The shiny input id to get the value from.
Returns
The value of the shiny input.
TealAppDriver$get_active_module_output()
Get the output from the module in the teal app.
This function will only access outputs from the name space of the current active teal module.
Usage
TealAppDriver$get_active_module_output(output_id)
Arguments
output_id(character) The shiny output id to get the value from.
Returns
The value of the shiny output.
TealAppDriver$get_active_module_table_output()
Get the output from the module's teal.widgets::table_with_settings or DT::DTOutput in the teal app.
This function will only access outputs from the name space of the current active teal module.
Usage
TealAppDriver$get_active_module_table_output(table_id, which = 1)
Arguments
table_id(
character(1)) The id of the table in the active teal module's name space.which(integer) If there is more than one table, which should be extracted. By default it will look for a table that is built using
teal.widgets::table_with_settings.
Returns
The data.frame with table contents.
TealAppDriver$get_active_module_plot_output()
Get the output from the module's teal.widgets::plot_with_settings in the teal app.
This function will only access plots from the name space of the current active teal module.
Usage
TealAppDriver$get_active_module_plot_output(plot_id)
Arguments
plot_id(
character(1)) The id of the plot in the active teal module's name space.
Returns
The src attribute as character(1) vector.
TealAppDriver$set_active_module_input()
Set the input in the module in the teal app.
This function will only set inputs in the name space of the current active teal module.
Usage
TealAppDriver$set_active_module_input(input_id, value, ...)
Arguments
input_id(character) The shiny input id to get the value from.
valueThe value to set the input to.
...Additional arguments to be passed to
shinytest2::AppDriver$set_inputs
Returns
The TealAppDriver object invisibly.
TealAppDriver$get_active_filter_vars()
Get the active datasets that can be accessed via the filter panel of the current active teal module.
Usage
TealAppDriver$get_active_filter_vars()
TealAppDriver$get_active_data_summary_table()
Get the active data summary table
Usage
TealAppDriver$get_active_data_summary_table()
Returns
data.frame
TealAppDriver$is_visible()
Test if DOM elements are visible on the page with a JavaScript call.
Usage
TealAppDriver$is_visible( selector, content_visibility_auto = FALSE, opacity_property = FALSE, visibility_property = FALSE )
Arguments
selector(
character(1))CSSselector to check visibility. ACSSid will return only one element if the UI is well formed.content_visibility_auto, opacity_property, visibility_property(
logical(1)) See more information on https://developer.mozilla.org/en-US/docs/Web/API/Element/checkVisibility.
Returns
Logical vector with all occurrences of the selector.
TealAppDriver$expect_visible()
Expect that DOM elements are visible on the page with a JavaScript call.
Usage
TealAppDriver$expect_visible( selector, content_visibility_auto = FALSE, opacity_property = FALSE, visibility_property = FALSE, timeout )
Arguments
selector(
character(1))CSSselector to check visibility. if more than one element is found, at least one must be visible for this expectation to be successful.content_visibility_auto, opacity_property, visibility_property(
logical(1)) See more information on https://developer.mozilla.org/en-US/docs/Web/API/Element/checkVisibility.timeout(
numeric(1)) Time in milliseconds to wait for the expectation to be met. Defaults to thetimeoutparameter set during initialization of theTealAppDriverobject.
TealAppDriver$expect_hidden()
Expect that DOM elements are hidden on the page with a JavaScript call.
Usage
TealAppDriver$expect_hidden( selector, content_visibility_auto = FALSE, opacity_property = FALSE, visibility_property = FALSE, timeout )
Arguments
selector(
character(1))CSSselector to check visibility. if more than one element is found, all of them must be invisible for this expectation to be successful.content_visibility_auto, opacity_property, visibility_property(
logical(1)) See more information on https://developer.mozilla.org/en-US/docs/Web/API/Element/checkVisibility.timeout(
numeric(1)) Time in milliseconds to wait for the expectation to be met. Defaults to thetimeoutparameter set during initialization of theTealAppDriverobject.
TealAppDriver$get_active_data_filters()
Get the active filter variables from a dataset in the teal app.
Usage
TealAppDriver$get_active_data_filters(dataset_name = NULL)
Arguments
dataset_name(character) The name of the dataset to get the filter variables from. If
NULL, the filter variables for all the datasets will be returned in a list.
TealAppDriver$add_filter_var()
Add a new variable from the dataset to be filtered.
Usage
TealAppDriver$add_filter_var(dataset_name, var_name, ...)
Arguments
dataset_name(character) The name of the dataset to add the filter variable to.
var_name(character) The name of the variable to add to the filter panel.
...Additional arguments to be passed to
shinytest2::AppDriver$set_inputs
Returns
The TealAppDriver object invisibly.
TealAppDriver$remove_filter_var()
Remove an active filter variable of a dataset from the active filter variables panel.
Usage
TealAppDriver$remove_filter_var(dataset_name = NULL, var_name = NULL)
Arguments
dataset_name(character) The name of the dataset to remove the filter variable from. If
NULL, all the filter variables will be removed.var_name(character) The name of the variable to remove from the filter panel. If
NULL, all the filter variables of the dataset will be removed.
Returns
The TealAppDriver object invisibly.
TealAppDriver$set_active_filter_selection()
Set the active filter values for a variable of a dataset in the active filter variable panel.
Usage
TealAppDriver$set_active_filter_selection(dataset_name, var_name, input, ...)
Arguments
dataset_name(character) The name of the dataset to set the filter value for.
var_name(character) The name of the variable to set the filter value for.
inputThe value to set the filter to.
...Additional arguments to be passed to
shinytest2::AppDriver$set_inputs
Returns
The TealAppDriver object invisibly.
TealAppDriver$get_attr()
Extract html attribute (found by a selector).
Usage
TealAppDriver$get_attr(selector, attribute)
Arguments
selector(
character(1)) specifying the selector to be used to get the content of a specific node.attribute(
character(1)) name of an attribute to retrieve from a node specified byselector.
Returns
The character vector.
TealAppDriver$get_html_rvest()
Wrapper around get_html that passes the output directly to rvest::read_html.
Usage
TealAppDriver$get_html_rvest(selector)
Arguments
selector(character(1))passed toget_html.
Returns
An XML document.
Wrapper around get_url() method that opens the app in the browser.
TealAppDriver$open_url()
Usage
TealAppDriver$open_url()
Returns
Nothing. Opens the underlying teal app in the browser.
TealAppDriver$wait_for_active_module_value()
Waits until a specified input, output, or export value.
This function serves as a wrapper around the wait_for_value method,
providing a more flexible interface for waiting on different types of values within the active module namespace.
Usage
TealAppDriver$wait_for_active_module_value( input = rlang::missing_arg(), output = rlang::missing_arg(), export = rlang::missing_arg(), ... )
Arguments
input, output, exportA name of an input, output, or export value. Only one of these parameters may be used.
...Must be empty. Allows for parameter expansion. Parameter with additional value to passed in
wait_for_value.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.