Retrieve time series data for one or more cohorts

Retrieve time series data for one or more cohorts

getCohortTimeSeriesData(
  connectionDetails = NULL,
  connection = NULL,
  cdmDatabaseSchema,
  tempEmulationSchema = NULL,
  cohortDatabaseSchema,
  cohortTable = "cohort",
  outputFolder,
  databaseId,
  cohortTimeSeriesArgs
)

Arguments

connectionDetails

An object of type connectionDetails as created using the createConnectionDetails function in the DatabaseConnector package. Can be left NULL if connection is provided.

connection

An object of type connection as created using the connect function in the DatabaseConnector package. Can be left NULL if connectionDetails is provided, in which case a new connection will be opened at the start of the function, and closed when the function finishes.

cdmDatabaseSchema

Schema name where your patient-level data in OMOP CDM format resides. Note that for SQL Server, this should include both the database and schema name, for example 'cdm_data.dbo'.

tempEmulationSchema

Some database platforms like Oracle and Impala do not truly support temp tables. To emulate temp tables, provide a schema with write privileges where temp tables can be created.

cohortDatabaseSchema

Schema name where your cohort table resides. Note that for SQL Server, this should include both the database and schema name, for example 'scratch.dbo'.

cohortTable

The name of the cohort table.

outputFolder

The location where the cohort time series data results will be written.

databaseId

The database identifier for the time series data

cohortTimeSeriesArgs

The cohort time series arguments. @seealso[createCohortTimeSeriesArgs] for more information.

Details

This function will retrieve a data frame representing entry events for one or more cohorts grouped into time intervals as specified by the cohortTimeSeriesArgs