addAge: Compute the age of the individuals at a certain date

In PatientProfiles: Identify Characteristics of Patients in the OMOP Common Data Model

Compute the age of the individuals at a certain date

Description

Compute the age of the individuals at a certain date

Usage

addAge(
  x,
  indexDate = "cohort_start_date",
  ageName = "age",
  ageGroup = NULL,
  ageMissingMonth = 1,
  ageMissingDay = 1,
  ageImposeMonth = FALSE,
  ageImposeDay = FALSE,
  ageUnit = "years",
  missingAgeGroupValue = "None",
  name = NULL,
  type = "numeric"
)

Arguments

x	A table containing individuals in a CDM reference.
indexDate	Name of a date column in x, or a single date to use for all rows, used as the reference date.
ageName	Name of the age column to add.
ageGroup	If not NULL, a list of age-group vectors.
ageMissingMonth	Month of the year assigned when month of birth is missing.
ageMissingDay	Day of the month assigned when day of birth is missing.
ageImposeMonth	If TRUE, month of birth is treated as missing for all individuals.
ageImposeDay	If TRUE, day of birth is treated as missing for all individuals.
ageUnit	Unit in which to express age: "years", "months", or "days".
missingAgeGroupValue	Value to use when age is missing.
name	Name of the new table. If NULL, a temporary table is returned.
type	Type of the created column(s). Counts, days, age, and observation durations can be "numeric" or "integer". Flag columns can also be "logical". Field columns can use "auto" to preserve the source type, or can be converted to "numeric", "integer", "logical", or "character".

Value

tibble with the age column added.

Examples

library(PatientProfiles)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort1 |>
  addAge()

PatientProfiles documentation built on Aug. 22, 2026, 1:07 a.m.