addDeathDays: Add days to death for individuals. Only death within the same...

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

Add days to death for individuals. Only death within the same observation period than indexDate will be observed.

Description

Add days to death for individuals. Only death within the same observation period than indexDate will be observed.

Usage

addDeathDays(
  x,
  indexDate = "cohort_start_date",
  censorDate = NULL,
  window = c(0, Inf),
  deathDaysName = "days_to_death",
  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.
censorDate	Date or name of a date column in x on which to censor follow-up. If NULL, no censoring is applied.
window	Window or windows of time relative to indexDate to consider.
deathDaysName	name of the new column to be added.
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

table x with the added column with death information added.

Examples

library(PatientProfiles)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort1 |>
  addDeathDays()

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