summariseCharacteristics {PatientProfiles}

Summarise characteristics of individuals

Description

'r lifecycle::badge("deprecated")'

Usage

summariseCharacteristics(
  cohort,
  cdm = lifecycle::deprecated(),
  strata = list(),
  demographics = TRUE,
  ageGroup = NULL,
  tableIntersect = list(),
  cohortIntersect = list(),
  conceptIntersect = list(),
  otherVariables = character()
)

Arguments

cohort

A cohort in the cdm.

cdm

A cdm reference.

strata

Stratification list.

demographics

Whether to summarise demographics data.

ageGroup

A list of age groups.

tableIntersect

A list of arguments that uses addTableIntersect function to add variables to summarise.

cohortIntersect

A list of arguments that uses addCohortIntersect function to add variables to summarise.

conceptIntersect

A list of arguments that uses addConceptIntersect function to add variables to summarise.

otherVariables

Other variables contained in cohort that you want to be summarised.

Value

A summary of the characteristics of the individuals.

Examples

library(PatientProfiles)

cdm <- mockPatientProfiles()

summariseCharacteristics(
  cohort = cdm$cohort1,
  ageGroup = list(c(0, 19), c(20, 39), c(40, 59), c(60, 79), c(80, 150)),
  tableIntersect = list(
    "Number visits prior year" = list(
      tableName = "visit_occurrence", value = "count", window = c(-365, -1)
    )
  ),
  cohortIntersect = list(
    "Drugs prior year" = list(
      targetCohortTable = "cohort2", value = "flag", window = c(-365, -1)
    ),
    "Conditions any time prior" = list(
      targetCohortTable = "cohort2", value = "flag", window = c(-Inf, -1)
    )
  )
)
CDMConnector::cdmDisconnect(cdm = cdm)