launchEvidenceExplorer: Launch the Evidence Explorer Shiny app

View source: R/Shiny.R

launchEvidenceExplorerR Documentation

Launch the Evidence Explorer Shiny app

Description

Launch the Evidence Explorer Shiny app

Usage

launchEvidenceExplorer(
  cohorts = "class",
  dataFolder = "data",
  dataFile = "PreMerged.RData",
  connectionDetails = NULL,
  blind = TRUE,
  aboutText = NULL,
  runOverNetwork = FALSE,
  port = 80,
  launch.browser = FALSE
)

Arguments

dataFolder

A folder where the premerged file is stored. Use the preMergeDiagnosticsFiles function to generate this file.

dataFile

(Optional) The name of the .RData file with results. It is commonly known as the Premerged file.

connectionDetails

An object of type connectionDetails as created using the createConnectionDetails function in the DatabaseConnector package, specifying how to connect to the server where the study results results have been uploaded using the uploadResults function.

blind

Should effect-estimates be hidden?

aboutText

Text (using HTML markup) that will be displayed in an About tab in the Shiny app. If not provided, no About tab will be shown.

runOverNetwork

(optional) Do you want the app to run over your network?

port

(optional) Only used if runOverNetwork = TRUE.

launch.browser

Should the app be launched in your default browser, or in a Shiny window. Note: copying to clipboard will not work in a Shiny window.

cohort

A string denoting which results schema to explore.

Details

Launches a Shiny app that allows the user to explore the evidence

Examples

## Not run: 
# OHDSI shinydb legendt2dm read-only credentials
appConnectionDetails <- DatabaseConnector::createConnectionDetails(
  dbms = "postgresql",
  server = paste(keyring::key_get("legendt2dmServer"),
                 keyring::key_get("legendt2dmDatabase"),
                 sep = "/"),
  user = keyring::key_get("legendt2dmUser"),
  password = keyring::key_get("legendt2dmPassword"))

# Run from db server (data download can take a long time)
LegendT2dmEvidenceExplorer::launchEvidenceExplorer(cohorts = "class",
                                                   connectionDetails = appConnectionDetails,
                                                   blind = TRUE)

## End(Not run)


ohdsi-studies/LegendT2dmEvidenceExplorer documentation built on Sept. 20, 2024, 1:18 a.m.