exportStaticApp {OmopViewer}R Documentation

Export and launch a static shiny specific to the provided results.

Description

Export and launch a static shiny specific to the provided results.

Usage

exportStaticApp(
  result,
  directory,
  logo = "ohdsi",
  title = "",
  background = TRUE,
  summary = TRUE,
  panelDetails = panelDetailsFromResult(result),
  panelStructure = NULL,
  theme = NULL,
  open = rlang::is_interactive()
)

Arguments

result

A summarised_result object.

directory

Directory to create the shiny.

Name of a logo or path to a logo. If NULL no logo is included. Only svg format allowed for the moment.

title

title of the shiny

background

Whether to include a background panel. Background panel content will be controlled from the generated background.md file.

summary

Whether to include a panel with a summary of content in the 'result'.

panelDetails

A named list to provide details for each one of the panels, such as: result_id, result_type, title, icon, filters and content. By default it is created using the 'panelDetailsFromResult()' function.

panelStructure

A named list of panel identifiers to organise them in drop-down menus. Identifiers names are the ones used in 'panelDetails'. By default one panel per each 'panelDetails' element is created.

theme

Specify the theme for the Shiny application. You can either select a predefined theme provided by the package (e.g., '"theme1"'), or define a custom theme using 'bslib::bs_theme()'. If using a custom theme, it must be provided as a character string (e.g., ‘"bslib::bs_theme(bg = ’white', fg = 'black')"').

open

Whether to open the shiny app project.

Value

The shiny app will be created in directory.

Examples

exportStaticApp(
  result = omopgenerics::emptySummarisedResult(),
  directory = tempdir()
)


[Package OmopViewer version 0.3.0 Index]