addDemographics: Compute demographic characteristics at a certain date

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

Compute demographic characteristics at a certain date

Description

Compute demographic characteristics at a certain date

Usage

addDemographics(
  x,
  indexDate = "cohort_start_date",
  age = TRUE,
  ageName = "age",
  ageMissingMonth = 1,
  ageMissingDay = 1,
  ageImposeMonth = FALSE,
  ageImposeDay = FALSE,
  ageUnit = "years",
  ageGroup = NULL,
  missingAgeGroupValue = "None",
  sex = TRUE,
  sexName = "sex",
  missingSexValue = "None",
  priorObservation = TRUE,
  priorObservationName = "prior_observation",
  priorObservationType = "days",
  futureObservation = TRUE,
  futureObservationName = "future_observation",
  futureObservationType = "days",
  dateOfBirth = FALSE,
  dateOfBirthName = "date_of_birth",
  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.
age	If TRUE, age is calculated relative to indexDate.
ageName	Name of the age column to add.
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".
ageGroup	If not NULL, a list of age-group vectors.
missingAgeGroupValue	Value to use when age is missing.
sex	If TRUE, sex is identified.
sexName	Name of the sex column to add.
missingSexValue	Value to use when sex is missing.
priorObservation	If TRUE, the time between the start of the current observation period and indexDate is calculated.
priorObservationName	Name of the prior-observation column to add.
priorObservationType	Whether to return a "date" or a number of "days".
futureObservation	If TRUE, the time between indexDate and the end of the current observation period is calculated.
futureObservationName	Name of the future-observation column to add.
futureObservationType	Whether to return a "date" or a number of "days".
dateOfBirth	If TRUE, date of birth is returned.
dateOfBirthName	Name of the date-of-birth column to add.
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

cohort table with the added demographic information columns.

Examples

library(PatientProfiles)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort1 |>
  addDemographics()

cdm$cohort1 |>
  addDemographics(indexDate = as.Date("2010-01-01"))

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