Summarise the observation period table getting some overall statistics in a summarised_result object.

Summarise the observation period table getting some overall statistics in a summarised_result object.

Usage

summariseObservationPeriod(
  observationPeriod,
  estimates = c("mean", "sd", "min", "q05", "q25", "median", "q75", "q95", "max"),
  density = FALSE
)

Arguments

observationPeriod

observation_period omop table.

estimates

Estimates to summarise the variables of interest ( records per person, duration and days to next observation period).

density

Whether to export density data for time between observation periods.

Value

A summarised_result object with the summarised data.

Examples

if (FALSE) { # \dontrun{
library(OmopSketch)
library(dplyr)

cdm <- mockOmopSketch()

result <- summariseObservationPeriod(cdm$observation_period)

result |>
  dplyr::glimpse()

PatientProfiles::mockDisconnect(cdm)
} # }