Format a summarise_characteristics object into a visual table.

Usage

tableCohortCount(
  result,
  type = "gt",
  header = "cohort_name",
  groupColumn = character(),
  hide = c("variable_level", settingsColumns(result))
)

Arguments

result

A summarised_result object.

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()

result <- summariseCohortCount(cdm$cohort1)
#> ℹ summarising data
#> ℹ summarising cohort cohort_1
#> ℹ summarising cohort cohort_2
#> ℹ summarising cohort cohort_3
#> ! `cdm_name` will be overwrite
#> ✔ summariseCharacteristics finished!

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


  
CDM name
      
Variable name
      
Estimate name
      

        
Cohort name
      
    
cohort_1
      
cohort_2
      
cohort_3
    
PP_MOCK
Number records
N
3
1
6

Number subjects
N
3
1
6

mockDisconnect(cdm = cdm)
# }