addCohortIntersectField: It creates a column with the field of a desired intersection

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

It creates a column with the field of a desired intersection

Description

It creates a column with the field of a desired intersection

Usage

addCohortIntersectField(
  x,
  targetCohortTable,
  field,
  targetCohortId = NULL,
  indexDate = "cohort_start_date",
  censorDate = NULL,
  targetDate = "cohort_start_date",
  order = "first",
  window = list(c(0, Inf)),
  nameStyle = "{cohort_name}_{field}_{window_name}",
  name = NULL,
  type = "auto"
)

Arguments

x	A table containing individuals in a CDM reference.
targetCohortTable	Name of the cohort table to intersect with.
field	Name or names of columns in the target tables to add to x.
targetCohortId	Cohort definition IDs to include from targetCohortTable. If NULL, all cohorts are included.
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.
targetDate	Name or names of date columns in the target tables to use for the intersection.
order	Which record to use when multiple records occur in a window: "first" or "last".
window	Window or windows of time relative to indexDate to consider.
nameStyle	Naming pattern for the added column or columns. It should include the required formatting variables. If more than one tableName is provided, it must include {table_name}.
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 with added columns with overlap information.

Examples

library(PatientProfiles)
library(dplyr)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort2 <- cdm$cohort2 |>
  mutate(even = if_else(subject_id %% 2, "yes", "no")) |>
  compute(name = "cohort2")

cdm$cohort1 |>
  addCohortIntersectFlag(
    targetCohortTable = "cohort2"
  )

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