Skip to content

OHDSI/OmopViewer

Repository files navigation

OmopViewer

R-CMD-check CRAN status Lifecycle: experimental Codecov test coverage

[!IMPORTANT] This package is under construction and this is just a first Beta release, please use it carefully and report any issue that you encounter using it.

The goal of OmopViewer is to allow the user to easily create Shiny Apps to visualise study results in <summarised_result> format.

Installation

You can install the development version of OmopViewer from GitHub with:

install.packages("pak")
pak::pkg_install("OHDSI/OmopViewer")

Main functionalities

library(OmopViewer)

The package can be divided in 3 main functionalities: - Static shiny app - Dynamic shiny app - Utility functions

Static shiny app

The static shiny app functionality creates a static shiny from a list of summarised_result objects. This shiny is specific to the set of results and can be modified later locally.

# lets generate some results
library(CohortCharacteristics)
cdm <- mockCohortCharacteristics()
result <- summariseCharacteristics(cdm$cohort1) |>
  bind(summariseCohortAttrition(cdm$cohort1))
#> ℹ adding demographics columns
#> ℹ summarising data
#> ✔ summariseCharacteristics finished!

exportStaticApp(result = result)
#> ℹ Processing data
#> ✔ Data processed: 2 result types idenfied: `summarise_characteristics` and
#>   `summarise_cohort_attrition`.
#> ℹ Creating shiny from provided data
#> ✔ Shiny created in: C:/Users/martics/Documents/GitHub/omopViewer/shiny

Dynamic shiny app

The dynamic shiny app can be easily launched with launchDynamicApp() function. This function creates a shinyApp where you can upload multiple results sets and visualise them.

launchDynamicApp()

Utility functions

  • tidyData is an experimental version of the tidy.summarised_result method defined in visOmopResults.
  • omopViewerTable is an experimental version of the visOmopTable function defined in visOmopResults.
  • filterData is a function used internally in the package to subset the result. It is not meant to be for user use. It is exported because it is used in the exportStaticApp() function.