createGetDbSccsDataArgs: Create a parameter object for the function getDbSccsData

In OHDSI/SelfControlledCaseSeries: Self-Controlled Case Series

Create a parameter object for the function getDbSccsData

Description

Create a parameter object for the function getDbSccsData

Usage

createGetDbSccsDataArgs(
  useCustomCovariates = FALSE,
  useNestingCohort = FALSE,
  nestingCohortId = NULL,
  deleteCovariatesSmallCount = 0,
  studyStartDate = "",
  studyEndDate = "",
  studyStartDates = c(),
  studyEndDates = c(),
  maxCasesPerOutcome = 0,
  exposureIds = "exposureId",
  customCovariateIds = ""
)

Arguments

useCustomCovariates	DEPRECATED. Set customCovariateIds to non-null value to use custom cohorts.
useNestingCohort	DEPRECATED. Set nestingCohortId to non-null value to use a nesting cohort.
nestingCohortId	A cohort definition ID identifying the records in the nestingCohortTable to use as nesting cohort.
deleteCovariatesSmallCount	The minimum count for a covariate to appear in the data to be kept.
studyStartDate	DEPRECATED. Use studyStartDates instead.
studyEndDate	DEPRECATED. Use studyEndDates instead.
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.
maxCasesPerOutcome	If there are more than this number of cases for a single outcome cases will be sampled to this size. maxCasesPerOutcome = 0 indicates no maximum size.
exposureIds	A list of identifiers to extract from the exposure table. If exposureTable = DRUG_ERA, exposureIds should be CONCEPT_ID. If exposureTable = "drug_era", exposureIds is used to select the drug_concept_id. If no exposure IDs are provided, all drugs or cohorts in the exposureTable are included as exposures.
customCovariateIds	A list of cohort definition IDs identifying the records in the customCovariateTable to use for building custom covariates.

Details

Create an object defining the parameter values.

OHDSI/SelfControlledCaseSeries documentation built on Sept. 7, 2024, 8:24 a.m.