cohortDiagnostics: Run cohort-level diagnostics

In PhenotypeR: Assess Study Cohorts Using a Common Data Model

Run cohort-level diagnostics

Description

Runs phenotypeR diagnostics on the cohort. The diganostics include: * Age groups and sex summarised. * A summary of visits of everyone in the cohort using visit_occurrence table. * A summary of age and sex density of the cohort. * Attritions of the cohorts. * Overlap between cohorts (if more than one cohort is being used).

Usage

cohortDiagnostics(cohort, survival = FALSE, matchedSample = 1000)

Arguments

cohort	Cohort table in a cdm reference
survival	Boolean variable. Whether to conduct survival analysis (TRUE) or not (FALSE).
matchedSample	The number of people to take a random sample for matching. If 'matchedSample = NULL', no sampling will be performed. If 'matchedSample = 0', no matched cohorts will be created.

Value

A summarised result

Examples

library(PhenotypeR)

cdm <- mockPhenotypeR()

result <- cohortDiagnostics(cdm$my_cohort)

CDMConnector::cdmDisconnect(cdm = cdm)

PhenotypeR documentation built on Aug. 8, 2025, 6:30 p.m.