requireDrugInDateRange {DrugUtilisation} | R Documentation |
Restrict cohort to only cohort records within a certain date range
Description
Filter the cohort table keeping only the cohort records for which the specified index date is within a specified date range.
Usage
requireDrugInDateRange(
cohort,
dateRange,
indexDate = "cohort_start_date",
cohortId = NULL,
name = omopgenerics::tableName(cohort)
)
Arguments
cohort |
A cohort_table object. |
dateRange |
Date interval to consider. Any records with the index date outside of this range will be dropped. |
indexDate |
The column containing the date that will be checked against the date range. |
cohortId |
A cohort definition id to restrict by. If NULL, all cohorts will be included. |
name |
Name of the new cohort table, it must be a length 1 character vector. |
Value
The cohort table having applied the date requirement.
Examples
library(DrugUtilisation)
library(dplyr)
cdm <- mockDrugUtilisation()
cdm$cohort1 <- cdm$cohort1 |>
requireDrugInDateRange(
dateRange = as.Date(c("2020-01-01", NA))
)
attrition(cdm$cohort1) |> glimpse()
[Package DrugUtilisation version 0.8.1 Index]