# Summarise and Visualise Characteristics of Patients in the OMOP CDM

## Documentation for package ‘CohortCharacteristics’ version 1.0.1

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

## Help Pages

availablePlotColumns | Available columns to use in 'facet' and 'colour' arguments in plot functions.
availableTableColumns | Available columns to use in 'header', 'groupColumn' and 'hide' arguments in table functions.
benchmarkCohortCharacteristics | Benchmark the main functions of CohortCharacteristics package.
mockCohortCharacteristics | It creates a mock database for testing CohortCharacteristics package
plotCharacteristics | Create a ggplot from the output of summariseCharacteristics.
plotCohortAttrition | create a ggplot from the output of summariseLargeScaleCharacteristics.
plotCohortCount | Plot the result of summariseCohortCount.
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
summariseCohortCodelist | Summarise the cohort codelist attribute
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 summarise_characteristics object into a visual table.
tableCohortAttrition | Create a visual table from the output of summariseCohortAttrition.
tableCohortCodelist | Create a visual table from <summarised_result> object from 'summariseCohortCodelist()'
tableCohortCount | Format a summarise_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 | Explore and compare the large scale characteristics of cohorts
tableTopLargeScaleCharacteristics | Visualise the top concepts per each cdm name, cohort, statification and window.