requireMinCohortCount: Filter cohorts to keep only records for those with a minimum...

In CohortConstructor: Build and Manipulate Study Cohorts Using a Common Data Model

Filter cohorts to keep only records for those with a minimum amount of subjects

Description

requireMinCohortCount() filters an existing cohort table, keeping only records from cohorts with a minimum number of individuals

Usage

requireMinCohortCount(
  cohort,
  minCohortCount,
  cohortId = NULL,
  updateSettings = FALSE,
  name = tableName(cohort)
)

Arguments

cohort	A cohort table in a cdm reference.
minCohortCount	The minimum count of sbjects for a cohort to be included.
cohortId	Vector identifying which cohorts to modify (cohort_definition_id or cohort_name). If NULL, all cohorts will be used; otherwise, only the specified cohorts will be modified, and the rest will remain unchanged.
updateSettings	If TRUE, dropped cohorts will also be removed from all cohort table attributes (i.e., settings, attrition, counts, and codelist). If FALSE, these attributes will be retained but updated to reflect that the affected cohorts have been suppressed.
name	Name of the new cohort table created in the cdm object.

Value

Cohort table

Examples

library(CohortConstructor)

cdm <- mockCohortConstructor(nPerson = 100)

cdm$cohort1 |>
requireMinCohortCount(5)

CohortConstructor documentation built on Aug. 8, 2025, 6:14 p.m.