Package 'OmopViewer'

Title: Visualise OMOP Results using 'shiny' Applications
Description: Visualise results obtained from analysing data mapped to the Observational Medical Outcomes Partnership (OMOP) common data model using 'shiny' applications.
Authors: Martí Català [aut, cre] , Yuchen Guo [aut] , Edward Burn [ctb] , Nuria Mercade-Besora [ctb] , Elin Rowlands [ctb] , Cecilia Campanile [ctb]
Maintainer: Martí Català <[email protected]>
License: Apache License (>= 2)
Version: 0.2.0
Built: 2024-11-20 01:22:21 UTC
Source: https://github.com/ohdsi/omopviewer

Help Index

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,
  panelStructure = NULL,
  panelDetails = NULL,
  theme = NULL,
  open = rlang::is_interactive(),
  panels = lifecycle::deprecated()
)

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'.
panelStructure

A named list of panel indetifiers to organise them in dropdown menus.
panelDetails

A named list to provide details for each one of the panels, such as: result_id, result_type, title, icon, output_id, ... Name of each element must be the identifier name of 'panelStructure'.
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.
panels

deprecated.

Value

The shiny app will be created in directory.

Examples

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

Launch a dynamic shiny app where you can upload results.

Description

Launch a dynamic shiny app where you can upload results.

Usage

launchDynamicApp()

Value

Launches the shiny app.