omopgenerics (version 1.1.1)

addSettings: Add settings columns to a <summarised_result> object

Description

Add settings columns to a <summarised_result> object

Usage

addSettings(result, settingsColumn = settingsColumns(result))

Value

A <summarised_result> object with the added setting columns.

Arguments

result

A <summarised_result> object.

settingsColumn

Settings to be added as columns, by default settingsColumns(result) will be added. If NULL or empty character vector, no settings will be added.

Examples

{
  library(dplyr)
  library(omopgenerics)

  x <- tibble(
    "result_id" = as.integer(c(1, 2)),
    "cdm_name" = c("cprd", "eunomia"),
    "group_name" = "cohort_name",
    "group_level" = "my_cohort",
    "strata_name" = "sex",
    "strata_level" = "male",
    "variable_name" = "Age group",
    "variable_level" = "10 to 50",
    "estimate_name" = "count",
    "estimate_type" = "numeric",
    "estimate_value" = "5",
    "additional_name" = "overall",
    "additional_level" = "overall"
  ) |>
    newSummarisedResult(settings = tibble(
      "result_id" = c(1, 2), "custom" = c("A", "B")
    ))

  x

  x |> addSettings()
}