estimatePointPrevalence {IncidencePrevalence} | R Documentation |
Estimate point prevalence
Description
Estimate point prevalence
Usage
estimatePointPrevalence(
cdm,
denominatorTable,
outcomeTable,
denominatorCohortId = NULL,
outcomeCohortId = NULL,
interval = "years",
timePoint = "start",
strata = list(),
includeOverallStrata = TRUE
)
Arguments
cdm |
A CDM reference object |
denominatorTable |
A cohort table with a set of denominator cohorts
(for example, created using the |
outcomeTable |
A cohort table in the cdm reference containing a set of outcome cohorts. |
denominatorCohortId |
The cohort definition ids or the cohort names of the denominator cohorts of interest. If NULL all cohorts will be considered in the analysis. |
outcomeCohortId |
The cohort definition ids or the cohort names of the outcome cohorts of interest. If NULL all cohorts will be considered in the analysis. |
interval |
Time intervals over which period prevalence is estimated. Can be "weeks", "months", "quarters", or "years". ISO weeks will be used for weeks. Calendar months, quarters, or years can be used as the period. If more than one option is chosen then results will be estimated for each chosen interval. |
timePoint |
where to compute the point prevalence |
strata |
Variables added to the denominator cohort table for which to stratify estimates. |
includeOverallStrata |
Whether to include an overall result as well as strata specific results (when strata has been specified). |
Value
Point prevalence estimates
Examples
cdm <- mockIncidencePrevalence(sampleSize = 1000)
cdm <- generateDenominatorCohortSet(
cdm = cdm, name = "denominator",
cohortDateRange = c(as.Date("2008-01-01"), as.Date("2018-01-01"))
)
estimatePointPrevalence(
cdm = cdm,
denominatorTable = "denominator",
outcomeTable = "outcome",
interval = "months"
)