Intersecting the cohort with columns of an OMOP table of user's choice. It will add an extra column to the cohort, indicating the intersected entries with the target columns in a window of the user's choice.

Usage

addTableIntersectField(
  x,
  tableName,
  field,
  indexDate = "cohort_start_date",
  censorDate = NULL,
  window = list(c(0, Inf)),
  targetDate = startDateColumn(tableName),
  inObservation = TRUE,
  order = "first",
  allowDuplicates = FALSE,
  nameStyle = "{table_name}_{field}_{window_name}",
  name = NULL
)

Arguments

x: Table with individuals in the cdm.
tableName: Name of the table to intersect with. Options: visit_occurrence, condition_occurrence, drug_exposure, procedure_occurrence, device_exposure, measurement, observation, drug_era, condition_era, specimen, episode.
field: The columns from the table in tableName to intersect over. For example, if the user uses visit_occurrence in tableName then for field the possible options include visit_occurrence_id, visit_concept_id, visit_type_concept_id.
indexDate: Variable in x that contains the date to compute the intersection.
censorDate: whether to censor overlap events at a specific date or a column date of x.
window: window to consider events in when intersecting with the chosen column.
targetDate: The dates in the target columns in tableName that the user may want to restrict to.
inObservation: If TRUE only records inside an observation period will be considered.
order: which record is considered in case of multiple records (only required for date and days options).
allowDuplicates: Whether to allow multiple records with same conceptSet, person_id and targetDate. If switched to TRUE, the created new columns (field) will be collapsed to a character vector separated by ; to account for multiple values per person.
nameStyle: naming of the added column or columns, should include required parameters.
name: Name of the new table, if NULL a temporary table is returned.

Value

table with added columns with intersect information.

Examples

# \donttest{
library(PatientProfiles)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort1 |>
  addTableIntersectField(
    tableName = "visit_occurrence",
    field = "visit_concept_id",
    order = "last",
    window = c(-Inf, -1)
  )
#> # Source:   table<og_160_1775495347> [?? x 5]
#> # Database: DuckDB 1.5.1 [unknown@Linux 6.17.0-1008-azure:R 4.5.3/:memory:]
#>    cohort_definition_id subject_id cohort_start_date cohort_end_date
#>                   <int>      <int> <date>            <date>         
#>  1                    2          2 1950-01-21        1951-03-23     
#>  2                    1          7 1954-07-16        1958-04-20     
#>  3                    2          6 1928-11-19        1944-10-18     
#>  4                    2         10 1936-08-08        1946-10-28     
#>  5                    2          5 1998-10-07        2002-03-14     
#>  6                    3          8 1960-08-27        1969-07-26     
#>  7                    3          3 1937-10-14        1959-07-30     
#>  8                    3          9 1981-10-10        1985-03-18     
#>  9                    3          1 1992-10-05        1993-09-16     
#> 10                    2          4 1904-06-14        1908-02-01     
#> # ℹ 1 more variable: visit_occurrence_visit_concept_id_minf_to_m1 <int>

# }