PatientProfiles (version 1.3.1)

addCategories: Categorize a numeric variable

Description

Categorize a numeric variable

Usage

addCategories(
  x,
  variable,
  categories,
  missingCategoryValue = "None",
  overlap = FALSE,
  includeLowerBound = TRUE,
  includeUpperBound = TRUE,
  name = NULL
)

Value

The x table with the categorical variable added.

Arguments

x

Table with individuals in the cdm.

variable

Target variable that we want to categorize.

categories

List of lists of named categories with lower and upper limit.

missingCategoryValue

Value to assign to those individuals not in any named category. If NULL or NA, missing values will not be changed.

overlap

TRUE if the categories given overlap.

includeLowerBound

Whether to include the lower bound in the group.

includeUpperBound

Whether to include the upper bound in the group.

name

Name of the new table, if NULL a temporary table is returned.

Examples

# \donttest{
cdm <- mockPatientProfiles()

result <- cdm$cohort1 |>
  addAge() |>
  addCategories(
    variable = "age",
    categories = list("age_group" = list(
      "0 to 39" = c(0, 39), "40 to 79" = c(40, 79), "80 to 150" = c(80, 150)
    ))
  )
mockDisconnect(cdm = cdm)
# }