launchWorkPackageExplorer: Launch the WorkPackages Shiny app

Description Usage Arguments Details Examples

View source: R/Shiny.R

Description

Launch the WorkPackages Shiny app

Usage

1
2
3
4
5
6
7
8
9
launchWorkPackageExplorer(
  connectionDetails = NULL,
  databaseSchema = NULL,
  dataFile = NULL,
  aboutText = NULL,
  runOverNetwork = FALSE,
  port = 80,
  launch.browser = FALSE
)

Arguments

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.

databaseSchema

The schema on the database server where the results have been uploaded.

dataFile

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

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.

Details

Launches a Shiny app that allows the user to explore WorkPackages

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
connectionDetails <- DatabaseConnector::createConnectionDetails(
  dbms = "postgresql",
  server = paste(keyring::key_get("workPackagesServer"),
              keyring::key_get("workPackagesDatabase"),
              sep = "/"),
  user = keyring::key_get("workPackagesReadOnlyUser"),
  password = keyring::key_get("workPackagesReadOnlyPassword"))

launchWorkPackageExplorer(connectionDetails = connectionDetails,
                          databaseSchema = paste0(keyring::key_get("workPackagesDatabase"), ".work_packages"))

OHDSI/WorkPackages documentation built on Jan. 28, 2022, 5 a.m.