Skip to contents

Add settings columns to a summaries_result object.

Usage

addSettings(
  result,
  settingsColumns = colnames(settings(result)),
  columns = lifecycle::deprecated()
)

Arguments

result

A summarised_result object.

settingsColumns

Settings to be added as columns, by default all settings will be added. If NULL or empty character vector, no settings will be added.

columns

[Deprecated]

Value

A summarised_result object with the added setting columns.

Examples

library(visOmopResults)
mockSummarisedResult() |>
  addSettings(settingsColumns = c("result_type"))
#> # A tibble: 126 × 14
#>    result_id cdm_name group_name  group_level strata_name       strata_level   
#>        <int> <chr>    <chr>       <chr>       <chr>             <chr>          
#>  1         1 mock     cohort_name cohort1     overall           overall        
#>  2         1 mock     cohort_name cohort1     age_group &&& sex <40 &&& Male   
#>  3         1 mock     cohort_name cohort1     age_group &&& sex >=40 &&& Male  
#>  4         1 mock     cohort_name cohort1     age_group &&& sex <40 &&& Female 
#>  5         1 mock     cohort_name cohort1     age_group &&& sex >=40 &&& Female
#>  6         1 mock     cohort_name cohort1     sex               Male           
#>  7         1 mock     cohort_name cohort1     sex               Female         
#>  8         1 mock     cohort_name cohort1     age_group         <40            
#>  9         1 mock     cohort_name cohort1     age_group         >=40           
#> 10         1 mock     cohort_name cohort2     overall           overall        
#> # ℹ 116 more rows
#> # ℹ 8 more variables: variable_name <chr>, variable_level <chr>,
#> #   estimate_name <chr>, estimate_type <chr>, estimate_value <chr>,
#> #   additional_name <chr>, additional_level <chr>, result_type <chr>