Format a summariseOverlapCohort result into a visual table.

Usage

tableCohortOverlap(
  result,
  uniqueCombinations = TRUE,
  type = "gt",
  header = c("variable_name"),
  groupColumn = c("cdm_name"),
  hide = c("variable_level", settingsColumns(result))
)

Arguments

result

A summarised_result object.

uniqueCombinations

Whether to restrict to unique reference and comparator comparisons.

type

Type of table. Check supported types with visOmopResults::tableType().

header

Columns to use as header. See options with availableTableColumns(result).

groupColumn

Columns to group by. See options with availableTableColumns(result).

hide

Columns to hide from the visualisation. See options with availableTableColumns(result).

Value

A formatted table.

Examples

# \donttest{
library(CohortCharacteristics)

cdm <- mockCohortCharacteristics()

overlap <- summariseCohortOverlap(cdm$cohort2)

tableCohortOverlap(overlap)
#> `result_id` is not present in result.
#> `result_id` is not present in result.
#> `result_id` is not present in result.
#> `result_id` is not present in result.


  
Cohort name reference
      
Cohort name comparator
      
Estimate name
      

        
Variable name
      
    
Only in reference cohort
      
In both cohorts
      
Only in comparator cohort
    
PP_MOCK
    
cohort_1
cohort_2
N (%)
6 (85.71%)
0 (0.00%)
1 (14.29%)

cohort_3
N (%)
6 (66.67%)
0 (0.00%)
3 (33.33%)
cohort_2
cohort_3
N (%)
1 (25.00%)
0 (0.00%)
3 (75.00%)

mockDisconnect(cdm = cdm)
# }