module_teal_module: Calls all 'modules'

module_teal_moduleR Documentation

Calls all modules

Description

On the UI side each teal_modules is translated to a tabsetPanel and each teal_module is a tabPanel. Both, UI and server are called recursively so that each tab is a separate module and reflect nested structure of modules argument.

Usage

ui_teal_module(id, modules, depth = 0L)

## Default S3 method:
ui_teal_module(id, modules, depth = 0L)

## S3 method for class 'teal_modules'
ui_teal_module(id, modules, depth = 0L)

## S3 method for class 'teal_module'
ui_teal_module(id, modules, depth = 0L)

srv_teal_module(
  id,
  data,
  modules,
  datasets = NULL,
  slices_global,
  reporter = teal.reporter::Reporter$new(),
  data_load_status = reactive("ok"),
  is_active = reactive(TRUE)
)

## Default S3 method:
srv_teal_module(
  id,
  data,
  modules,
  datasets = NULL,
  slices_global,
  reporter = teal.reporter::Reporter$new(),
  data_load_status = reactive("ok"),
  is_active = reactive(TRUE)
)

## S3 method for class 'teal_modules'
srv_teal_module(
  id,
  data,
  modules,
  datasets = NULL,
  slices_global,
  reporter = teal.reporter::Reporter$new(),
  data_load_status = reactive("ok"),
  is_active = reactive(TRUE)
)

## S3 method for class 'teal_module'
srv_teal_module(
  id,
  data,
  modules,
  datasets = NULL,
  slices_global,
  reporter = teal.reporter::Reporter$new(),
  data_load_status = reactive("ok"),
  is_active = reactive(TRUE)
)

Arguments

id

(character(1)) shiny module instance id.

modules

(teal_modules) teal_modules object. These are the specific output modules which will be displayed in the teal application. See modules() and module() for more details.

depth

(integer(1)) number which helps to determine depth of the modules nesting.

data

(reactive returning teal_data)

datasets

(reactive returning FilteredData or NULL) When datasets is passed from the parent module (srv_teal) then dataset is a singleton which implies in filter-panel to be "global". When NULL then filter-panel is "module-specific".

slices_global

(reactiveVal returning modules_teal_slices) see module_filter_manager

data_load_status

(reactive returning character) Determines action dependent on a data loading status:

  • "ok" when teal_data is returned from the data loading.

  • "teal_data_module failed" when teal_data_module() didn't return teal_data. Disables tabs buttons.

  • "external failed" when a reactive passed to srv_teal(data) didn't return teal_data. Hides the whole tab panel.

Value

output of currently active module.

  • srv_teal_module.teal_module returns reactiveVal containing output of the called module.

  • srv_teal_module.teal_modules returns output of module selected by input$active_tab.


teal documentation built on April 3, 2025, 5:32 p.m.