Return example data — example_sample

Return example data based on the specified characteristics.

Usage

example_sample_data(
  is_timevar = TRUE,
  is_aggregated = TRUE,
  special_case = NULL,
  family = "binomial"
)

is_timevar: Logical indicating whether the data is time-varying.
is_aggregated: Logical indicating whether the data is aggregated.
special_case: Optional character string for specific use cases such as COVID data. Options are NULL, "covid" and "poll". The default is NULL which indicates the data is not specific to any supported use case.
family: Character string specifying the distribution family for outcome measures. Options are "binomial" for binary outcomes and "normal" for continuous outcomes.

A data.frame object.