getExampleConnectionDetails: create a connection detail for an example OHDSI results...

View source: R/Helpers.R

getExampleConnectionDetailsR Documentation

create a connection detail for an example OHDSI results database

Description

This returns an object of class 'ConnectionDetails' that lets you connect via 'DatabaseConnector::connect()' to the example result database.

Usage

getExampleConnectionDetails(exdir = tempdir())

Arguments

exdir

a directory to unzip the example result data into. Default is tempdir().

Details

Finds the location of the example result database in the package and calls 'DatabaseConnector::createConnectionDetails' to create a 'ConnectionDetails' object for connecting to the database.

Value

An object of class 'ConnectionDetails' with the details to connect to the example OHDSI result database

See Also

Other helper: kableDark(), printReactable(), removeSpaces()

Examples

conDet <- getExampleConnectionDetails()

connectionHandler <- ResultModelManager::ConnectionHandler$new(conDet)


OhdsiReportGenerator documentation built on April 12, 2025, 2:09 a.m.