# Summarise and Visualise Characteristics of Patients in the OMOP CDM

## Documentation for package ‘CohortCharacteristics’ version 0.2.2

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

mockCohortCharacteristics | It creates a mock database for testing CohortCharacteristics package
optionsTableCharacteristics | Additional arguments for the function tableCharacteristics.
optionsTableCohortOverlap | Additional arguments for the function tableCohortOverlap.
optionsTableCohortTiming | Additional arguments for the function tableCohortTiming.
plotCharacteristics | Create a ggplot from the output of summariseCharacteristics. 'r lifecycle::badge("experimental")'
plotCohortAttrition | create a ggplot from the output of summariseLargeScaleCharacteristics.
plotCohortOverlap | Plot the result of summariseCohortOverlap.
plotCohortTiming | Plot summariseCohortTiming results.
plotComparedLargeScaleCharacteristics | create a ggplot from the output of summariseLargeScaleCharacteristics.
plotLargeScaleCharacteristics | create a ggplot from the output of summariseLargeScaleCharacteristics.
summariseCharacteristics | Summarise characteristics of cohorts in a cohort table
summariseCohortAttrition | Summarise attrition associated with cohorts in a cohort table
summariseCohortCount | Summarise counts for cohorts in a cohort table
summariseCohortOverlap | Summarise overlap between cohorts in a cohort table
summariseCohortTiming | Summarise timing between entries into cohorts in a cohort table
summariseLargeScaleCharacteristics | This function is used to summarise the large scale characteristics of a cohort table
tableCharacteristics | Format a summarised_characteristics object into a visual table.
tableCohortAttrition | Create a visual table from the output of summariseCohortAttrition. 'r lifecycle::badge("experimental")'
tableCohortCount | Format a summarised_characteristics object into a visual table.
tableCohortOverlap | Format a summariseOverlapCohort result into a visual table.
tableCohortTiming | Format a summariseCohortTiming result into a visual table.
tableLargeScaleCharacteristics | Format a summarised_large_scale_characteristics object into a visual table.