Create a cohort entry definition

Source: R/cohort.R

Defines the index event(s) and required observation window for a cohort. Each query passed as ... is a candidate index event; a person enters the cohort at the first (or all, depending on primaryCriteriaLimit) qualifying event.

entry(
  ...,
  observationWindow = continuousObservation(0L, 0L),
  primaryCriteriaLimit = c("First", "All", "Last"),
  additionalCriteria = NULL,
  qualifiedLimit = NULL
)

Arguments

...

One or more Query objects (e.g. conditionOccurrence(), drugExposure()).

observationWindow

Minimum continuous observation before and after index. See continuousObservation. Default continuousObservation(0L, 0L).

primaryCriteriaLimit

Whether to index on "First", "Last", or "All" qualifying events per person.

additionalCriteria

An optional Group (withAll/withAny) further restricting which events qualify as the index. See withAll.

qualifiedLimit

Result limit after applying additionalCriteria. Required when additionalCriteria is non-NULL; defaults to primaryCriteriaLimit.

Value

A CohortEntry object.

Examples

t2dm <- cs(descendants(201826L), name = "T2DM")
entry(conditionOccurrence(t2dm), primaryCriteriaLimit = "First")
#> An object of class "CohortEntry"
#> Slot "entryEvents":
#> [[1]]
#> <Capr ConditionOccurrence Query> T2DM 
#> 
#> 
#> Slot "observationWindow":
#> An object of class "ObservationWindow"
#> Slot "priorDays":
#> [1] 0
#> 
#> Slot "postDays":
#> [1] 0
#> 
#> 
#> Slot "primaryCriteriaLimit":
#> [1] "First"
#> 
#> Slot "additionalCriteria":
#> An object of class "Group"
#> Slot "occurrence":
#> An object of class "Occurrence"
#> Slot "type":
#> [1] NA
#> 
#> Slot "count":
#> [1] NA
#> 
#> Slot "isDistinct":
#> [1] NA
#> 
#> Slot "countColumn":
#> [1] NA
#> 
#> 
#> Slot "criteria":
#> list()
#> 
#> Slot "group":
#> list()
#> 
#> 
#> Slot "qualifiedLimit":
#> [1] "First"
#>