Package 'OmopViewer'

Default panels defined in the package.

Description

Default panels defined in the package.

Usage

defaultPanels()

Value

Names of the default panels defined in the package.

Examples

defaultPanels()

---

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 = NULL,
  title = "",
  background = TRUE,
  summary = TRUE,
  report = FALSE,
  panelDetails = panelDetailsFromResult(result),
  panelStructure = NULL,
  theme = NULL,
  template = NULL,
  updateButtons = TRUE,
  includeOneChoiceFilters = TRUE,
  open = rlang::is_interactive()
)

Arguments

result	A summarised_result object.
directory	Directory to create the shiny.
logo	Name of a logo or path to a logo. If NULL no logo is obtained from theme.
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.
report	Whether to include a quarto report.
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')").
template	Path to a template .docx document to be used for the report.
updateButtons	Whether to include update buttons for visualisations.
includeOneChoiceFilters	Whether to include filter buttons for filters with just one choice.
open	Whether to open the shiny app project.

Value

The shiny app will be created in directory.

Examples

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

---

Get one of the default pre-built panels.

Description

Get one of the default pre-built panels.

Usage

getPanel(panelId)

Arguments

panelId

Name of the one of the default panels. Use defaultPanels() to see the available default panels.

Value

A panel definition.

Examples

getPanel("incidence")

---

Launch a dynamic shiny app where you can upload results.

Description

Usage

launchDynamicApp()

Value

Launches the shiny app.

---

Panels defined in the package.

Description

The panels are generated using the following file: https://github.com/OHDSI/OmopViewer/blob/main/data-raw/panels.R.

Usage

omopViewerPanels

Format

omopViewerPanels

A list of 26 omopviewer_panel obejcts

---

Mock results obtained from GiBleed dataset.

Description

The results are generated using the following file: https://github.com/OHDSI/OmopViewer/blob/main/data-raw/results.R.

Usage

omopViewerResults

Format

omopViewerResults

A summarised_result object with 12,017 rows

---

List the available configured OmopViewer themes

Description

List the available configured OmopViewer themes

Usage

omopViewerThemes()

Value

A character vector with the available OmopViewer themes.

Examples

library(OmopViewer)

omopViewerThemes()

---

Obtain default panel details from a ⁠<summarised_result>⁠ object.

Description

Obtain default panel details from a ⁠<summarised_result>⁠ object.

Usage

panelDetailsFromResult(result, includeOneChoiceFilters = TRUE)

Arguments

result	A summarised_result object.
includeOneChoiceFilters	Whether to include filters that contain only one choice.

Value

A list of omop_viewer_panel objects.

Examples

panelDetailsFromResult(omopViewerResults)

---