View source: R/DataLoadingSaving.R
getDbSccsData | R Documentation |
Load all data needed to perform an SCCS analysis from the database.
getDbSccsData(
connectionDetails,
cdmDatabaseSchema,
tempEmulationSchema = getOption("sqlRenderTempEmulationSchema"),
outcomeDatabaseSchema = cdmDatabaseSchema,
outcomeTable = "condition_era",
outcomeIds,
exposureDatabaseSchema = cdmDatabaseSchema,
exposureTable = "drug_era",
exposureIds = c(),
useCustomCovariates = FALSE,
customCovariateDatabaseSchema = cdmDatabaseSchema,
customCovariateTable = "cohort",
customCovariateIds = c(),
useNestingCohort = FALSE,
nestingCohortDatabaseSchema = cdmDatabaseSchema,
nestingCohortTable = "cohort",
nestingCohortId = NULL,
deleteCovariatesSmallCount = 0,
studyStartDate = "",
studyEndDate = "",
studyStartDates = c(),
studyEndDates = c(),
cdmVersion = "5",
maxCasesPerOutcome = 0
)
connectionDetails |
An R object of type |
cdmDatabaseSchema |
The name of the database schema that contains the OMOP CDM instance. Requires read permissions to this database. On SQL Server, this should specify both the database and the schema, so for example 'cdm_instance.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. |
outcomeDatabaseSchema |
The name of the database schema that is the location where
the data used to define the outcome cohorts is available. If
|
outcomeTable |
The table name that contains the outcome cohorts. If
|
outcomeIds |
A list of IDs used to define outcomes. If |
exposureDatabaseSchema |
The name of the database schema that is the location where
the exposure data used to define the exposure eras is
available. If |
exposureTable |
The tablename that contains the exposure cohorts. If
|
exposureIds |
A list of identifiers to extract from the exposure table. If
exposureTable = DRUG_ERA, exposureIds should be CONCEPT_ID.
If |
useCustomCovariates |
DEPRECATED. Set |
customCovariateDatabaseSchema |
The name of the database schema that is the location where the custom covariate data is available. |
customCovariateTable |
Name of the table holding the custom covariates. This table should have the same structure as the cohort table (see details). |
customCovariateIds |
A list of cohort definition IDs identifying the records in
the |
useNestingCohort |
DEPRECATED. Set |
nestingCohortDatabaseSchema |
The name of the database schema that is the location where the nesting cohort is defined. |
nestingCohortTable |
Name of the table holding the nesting cohort. This table should have the same structure as the cohort table (see details). |
nestingCohortId |
A cohort definition ID identifying the records in the
|
deleteCovariatesSmallCount |
The minimum count for a covariate to appear in the data to be kept. |
studyStartDate |
DEPRECATED. Use |
studyEndDate |
DEPRECATED. Use |
studyStartDates |
A character object specifying the minimum dates where data is used. Date format is 'yyyymmdd'. Use "" to indicate all time prior. See section for more information. |
studyEndDates |
A character object specifying the maximum dates where data is used. Date format is 'yyyymmdd'. Use "" to indicate to the end of observation. See section for more information. |
cdmVersion |
Define the OMOP CDM version used: currently supports "5". |
maxCasesPerOutcome |
If there are more than this number of cases for a single
outcome cases will be sampled to this size. |
This function downloads several types of information:
Information on the occurrences of the outcome(s) of interest. Note that information for multiple outcomes can be fetched in one go, and later the specific outcome can be specified for which we want to build a model.
Information on the observation time and age for the people with the outcomes.
Information on exposures of interest which we want to include in the model.
Five different database schemas can be specified, for five different types of information: The
cdmDatabaseSchema is used to extract patient age and observation period. The
outcomeDatabaseSchema is used to extract information about the outcomes, the
exposureDatabaseSchema is used to retrieve information on exposures, and the
customCovariateDatabaseSchema is optionally used to find additional, user-defined covariates. All four locations could point to the same database schema.
nestingCohortDatabaseSchema is optionally used to define a cohort in which the analysis is nested, for example a cohort of diabetics patients.
All five locations could point to the same database schema.
Cohort tables are assumed to have the following fields: cohort_definition_id
, subject_id
,
cohort_start_date
, and cohort_end_date.
An SccsData object.
A study start and end date define a period when patient data will be included in the analysis. Multiple non-overlapping periods can be defined, which for example will allow for excluding the time of the COVID pandemic, when most outcome rates were unstable.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.