summarise_cohort_attrition

summarise_cohort_attrition(cohort, cdm=None, *, cohort_id=None)

Summarise attrition for cohorts.

Reads cohort_attrition metadata and formats it as a SummarisedResult with number_records, number_subjects, excluded_records, excluded_subjects per attrition step.

Parameters

Name	Type	Description	Default
cohort	Cohort table with cohort_attrition attribute.		required
cdm	Optional Cdm for cdm_name.		None
cohort_id	Optional cohort_definition_id(s) to include.		None

Returns

Name	Type	Description
	SummarisedResult