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

Usage

exportStaticApp(
  result,
  logo = "ohdsi",
  title = "",
  background = NULL,
  summary = TRUE,
  directory = getwd(),
  panels = list(),
  theme = NULL,
  open = rlang::is_interactive()
)

Arguments

result: A summarised_result object.
logo: 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: Content to fill the background panel. If `NULL`, this panel will not appear in the Shiny UI. This argument can be populated in two ways: 1) A character string containing `bslib` code to go directly inside `bslib::card()`. 2) A named character vector where the names correspond to specific`bslib` card elements: "header", "title", "subtitle", "body", and "footer". Each element's name indicates the type of text it will fill. The order of these elements is important when displaying the content. Markdown sythax for text styling is supported.
summary: Whether to include a panel with a summary of content in the `result`.
directory: Directory to create the shiny.
panels: List specifying order of results. Each panel is determined by the available result types in the result object. Panels for any available results not specified will be included after the specified result tabs.
theme: Assign a theme to the shiny app using bslib::bs_theme()
open: Whether to open the shiny app project.

Value

The shiny app will be created in directory.

Examples

{
exportStaticApp(
  result = emptySummarisedResult(),
  theme = "bslib::bs_theme(bg = '#bb0a1e', fg = '#0000ff')"
)
}
#> A summarised_result object with 0 rows, 0 different result_id, different cdm
#> names, and 3 settings.
#> Settings: result_type, package_name, and package_version.
#> ℹ Processing data
#> ! Data processed: 0 result types idenfied.
#> ! No result_type(s) found, the generated shiny will be empty.
#> ℹ Creating shiny from provided data
#> ✔ Shiny created in:
#>   /home/runner/work/omopViewer/omopViewer/docs/reference/shiny