summariseInObservation {OmopSketch} | R Documentation |
Summarise the number of people in observation during a specific interval of time.
Description
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 list containing the minimum and the maximum dates defining the time range within which the analysis is performed. |
Value
A summarised_result object.
Examples
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()
PatientProfiles::mockDisconnect(cdm)
[Package OmopSketch version 0.2.0 Index]