OmopSketch (version 0.5.1)

summariseMissingData: Summarise missing data in omop tables

Description

Summarise missing data in omop tables

Usage

summariseMissingData(
  cdm,
  omopTableName,
  col = NULL,
  sex = FALSE,
  year = lifecycle::deprecated(),
  interval = "overall",
  ageGroup = NULL,
  sample = 1e+06,
  dateRange = NULL
)

Value

A summarised_result object with results overall and, if specified, by strata.

Arguments

cdm

A cdm object

omopTableName

A character vector of the names of the tables to summarise in the cdm object.

col

A character vector of column names to check for missing values. If NULL, all columns in the specified tables are checked. Default is NULL.

sex

TRUE or FALSE. If TRUE code use will be summarised by sex.

year

deprecated

interval

Time interval to stratify by. It can either be "years", "quarters", "months" or "overall".

ageGroup

A list of ageGroup vectors of length two. Code use will be thus summarised by age groups.

sample

An integer to sample the table to only that number of records. If NULL no sample is done.

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.

Examples

# \donttest{
cdm <- mockOmopSketch(numberIndividuals = 100)

result <- summariseMissingData (cdm = cdm,
omopTableName = c("condition_occurrence", "visit_occurrence"),
sample = 10000)

PatientProfiles::mockDisconnect(cdm)
# }