Get the different options that a summarised_result have.

Usage

getChoices(result, flatten = FALSE)

Arguments

result: A `<summarised_result>` object.
flatten: Whether to flatten to a single list or not.

Value

A named list with the options

Examples

library(CohortCharacteristics)

cdm <- mockCohortCharacteristics()
#> Note: method with signature ‘DBIConnection#Id’ chosen for function ‘dbExistsTable’,
#>  target signature ‘duckdb_connection#Id’.
#>  "duckdb_connection#ANY" would also be valid

result <- cdm$cohort1 |>
  summariseCharacteristics()
#> ℹ adding demographics columns
#> ℹ summarising data
#> ✔ summariseCharacteristics finished!

getChoices(result)
#> $summarise_characteristics
#> $summarise_characteristics$settings
#> $summarise_characteristics$settings$table_name
#> [1] "cohort1"
#> 
#> 
#> $summarise_characteristics$grouping
#> $summarise_characteristics$grouping$cdm_name
#> [1] "PP_MOCK"
#> 
#> $summarise_characteristics$grouping$cohort_name
#> [1] "cohort_1" "cohort_2" "cohort_3"
#> 
#> 
#> $summarise_characteristics$variable_name
#> [1] "Age"                "Cohort end date"    "Cohort start date" 
#> [4] "Days in cohort"     "Future observation" "Number records"    
#> [7] "Number subjects"    "Prior observation"  "Sex"               
#> 
#> $summarise_characteristics$estimate_name
#> [1] "count"      "max"        "mean"       "median"     "min"       
#> [6] "percentage" "q25"        "q75"        "sd"        
#> 
#> $summarise_characteristics$tidy_columns
#> [1] "cdm_name"    "cohort_name" "table_name" 
#> 
#>