gather_strat_variable: A Function to Gather a Stratified Variable into a Tidy Format

In idmodelr: Infectious Disease Model Library and Utilities

A Function to Gather a Stratified Variable into a Tidy Format

Description

A Function to Gather a Stratified Variable into a Tidy Format

Usage

gather_strat_variable(
  df,
  id_col,
  compartment,
  hold_out_var = NULL,
  strat,
  groups = NULL
)

Arguments

df	A data frame with variables stratified using numeric labels.
id_col	A character string containing the name of the new id column.
compartment	The compartment to reduce the dimension of.
hold_out_var	A character vector specifying the variables to keep unchanged. Defaults to NULL
strat	An integer specifying the number of stratifications to reduce.
groups	A character vector with length equal to the level of stratification. Used to name the stratified levels.

Value

A dataframe of stratified model output with a single Tidy variable.

Examples

df <- data.frame(time = 0, A1 = 1, A2 = 2, A3 = 3)
gather_strat_variable(df, id_col = "Age", compartment = "A",
                      strat = 3, groups = c("Children", "Young adults", "Adults"))

idmodelr documentation built on Sept. 2, 2022, 5:06 p.m.