createGetDbCaseDataArgs: Create a parameter object for the function getDbCaseData

View source: R/CreateArgFunctions.R

createGetDbCaseDataArgsR Documentation

Create a parameter object for the function getDbCaseData

Description

Create a parameter object for the function getDbCaseData

Usage

createGetDbCaseDataArgs(
  useNestingCohort = FALSE,
  useObservationEndAsNestingEndDate = TRUE,
  getVisits = FALSE,
  studyStartDate = "",
  studyEndDate = "",
  maxNestingCohortSize = 1e+07,
  maxCasesPerOutcome = 5e+05
)

Arguments

useNestingCohort

Should the study be nested in a cohort (e.g. people with a specific indication)? If not, the study will be nested in the general population.

useObservationEndAsNestingEndDate

When using a nesting cohort, should the observation period end date be used instead of the cohort end date?

getVisits

Get data on visits? This is needed when matching on visit date is requested later on.

studyStartDate

A calendar date specifying the minimum date where data is used. Date format is 'yyyymmdd'.

studyEndDate

A calendar date specifying the maximum date where data is used. Date format is 'yyyymmdd'.

maxNestingCohortSize

If the nesting cohort is larger than this number it will be sampled to this size. maxCohortSize = 0 indicates no maximum size.

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.

Details

Create an object defining the parameter values.


OHDSI/CaseControl documentation built on July 15, 2022, 6:33 a.m.