Summarise the number of people in observation during a specific interval of time.

Usage

summariseInObservation(
  observationPeriod,
  interval = "overall",
  output = "records",
  ageGroup = NULL,
  sex = FALSE,
  dateRange = NULL
)

Arguments

observationPeriod: An observation_period omop table. It must be part of a cdm_reference object.
interval: Time interval to stratify by. It can either be "years", "quarters", "months" or "overall".
output: Output format. It can be either the number of records ("records") that are in observation in the specific interval of time, the number of person-days ("person-days"), or both c("records","person-days").
ageGroup: A list of age groups to stratify results by.
sex: Boolean variable. Whether to stratify by sex (TRUE) or not (FALSE).
dateRange: A vector of two dates defining the desired study period. Only the start_date column of the OMOP table is checked to ensure it falls within this range. If dateRange is NULL, no restriction is applied.

Value

A summarised_result object.

Examples

# \donttest{
library(dplyr, warn.conflicts = FALSE)

cdm <- mockOmopSketch()

result <- summariseInObservation(
  cdm$observation_period,
  interval = "months",
  output = c("person-days","records"),
  ageGroup = list("<=60" = c(0,60), ">60" = c(61, Inf)),
  sex = TRUE
)

result |>
  glimpse()
#> Rows: 16,400
#> Columns: 13
#> $ result_id        <int> 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,…
#> $ cdm_name         <chr> "mockOmopSketch", "mockOmopSketch", "mockOmopSketch",…
#> $ group_name       <chr> "omop_table", "omop_table", "omop_table", "omop_table…
#> $ group_level      <chr> "observation_period", "observation_period", "observat…
#> $ strata_name      <chr> "sex &&& age_group", "sex", "sex &&& age_group", "sex…
#> $ strata_level     <chr> "Female &&& <=60", "Female", "Female &&& <=60", "Fema…
#> $ variable_name    <chr> "Number person-days", "Number person-days", "Number r…
#> $ variable_level   <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, N…
#> $ estimate_name    <chr> "count", "count", "count", "count", "count", "count",…
#> $ estimate_type    <chr> "integer", "integer", "integer", "integer", "integer"…
#> $ estimate_value   <chr> "29", "29", "1", "1", "30", "30", "1", "1", "31", "31…
#> $ additional_name  <chr> "time_interval", "time_interval", "time_interval", "t…
#> $ additional_level <chr> "1957-10-01 to 1957-10-31", "1957-10-01 to 1957-10-31…

PatientProfiles::mockDisconnect(cdm)

# }