OhdsiReportGenerator (version 2.0.2)

getSccsModel: Extract the SCCS model table

Description

This function extracts the sccs model table.

Usage

getSccsModel(
  connectionHandler,
  schema,
  sccsTablePrefix = "sccs_",
  cgTablePrefix = "cg_",
  databaseTable = "database_meta_data",
  exposureOutcomeSetIds = NULL,
  indicationIds = NULL,
  outcomeIds = NULL,
  databaseIds = NULL,
  analysisIds = NULL,
  targetIds = NULL
)

Value

Returns a data.frame with the SCCS model table

Arguments

connectionHandler

A connection handler that connects to the database and extracts sql queries. Create a connection handler via `ResultModelManager::ConnectionHandler$new()`.

schema

The result database schema (e.g., 'main' for sqlite)

sccsTablePrefix

The prefix used for the cohort generator results tables

cgTablePrefix

The prefix used for the cohort generator results tables

databaseTable

The name of the table with the database details (default 'database_meta_data')

exposureOutcomeSetIds

the exposureOutcomeIds to restrict to

indicationIds

The indications that the target was nested to

outcomeIds

A vector of integers corresponding to the outcome cohort IDs

databaseIds

the database IDs to restrict to

analysisIds

the analysis IDs to restrict to

targetIds

A vector of integers corresponding to the target cohort IDs

Details

Specify the connectionHandler, the schema and optionally the target/outcome/analysis/database IDs

See Also

Other Estimation: getCMEstimation(), getCmDiagnosticsData(), getCmMetaEstimation(), getCmNegativeControlEstimates(), getCmOutcomes(), getCmPropensityModel(), getCmTable(), getCmTargets(), getSccsDiagnosticsData(), getSccsEstimation(), getSccsMetaEstimation(), getSccsNegativeControlEstimates(), getSccsOutcomes(), getSccsTable(), getSccsTargets(), getSccsTimeToEvent(), plotCmEstimates(), plotSccsEstimates()

Examples

conDet <- getExampleConnectionDetails()

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

sccsModels <- getSccsModel(
  connectionHandler = connectionHandler, 
  schema = 'main'
)