gather_strat_multi_variable

A Function to Gather Multiple Stratified Variables into a Tidy Format

Explore a range of infectious disease models in a consistent
framework. The primary aim of 'idmodelr' is to provide a library of
infectious disease models for researchers, students, and other interested
individuals. These models can be used to understand the underlying dynamics
and as a reference point when developing models for research. 'idmodelr'
also provides a range of utilities. These include: plotting functionality;
a simulation wrapper; scenario analysis tooling; an interactive dashboard;
tools for handling mult-dimensional models; and both model and parameter
look up tables. Unlike other modelling packages such as 'pomp'
(<https://kingaa.github.io/pomp/>), 'libbi' (<http://libbi.org>)
and 'EpiModel' (<http://www.epimodel.org>), 'idmodelr' serves primarily as
an educational resource. It is most comparable to epirecipes
(<http://epirecip.es/epicookbook/chapters/simple>) but provides a more
consistent framework, an R based workflow, and additional utility tooling.
After users have explored model dynamics with 'idmodelr' they may then
implement their model using one of these packages in order to utilise the
model fitting tools they provide. For newer modellers, this package
reduces the barrier to entry by containing multiple infectious disease
models, providing a consistent framework for simulation and visualisation,
and signposting towards other, more research focussed, resources.

Sam Abbott 

idmodelr

Infectious Disease Model Library and Utilities

Akira Endo 

gather_strat_multi_variable function

<dl><dt>df</dt>
<dd>A data frame with variables stratified using numeric labels.</dd>
<dt>id_col</dt>
<dd>A character string containing the name of the new id column.</dd>
<dt>compartments</dt>
<dd>A character vector specifying the unique population compartments.</dd>
<dt>hold_out_var</dt>
<dd>A character vector specifying the variables to keep unchanged. Defaults to NULL</dd>
<dt>strat</dt>
<dd>An integer specifying the number of stratifications to reduce.</dd>
<dt>groups</dt>
<dd>A character vector with length equal to the level of stratification.
Used to name the stratified levels.</dd></dl>

Arguments

A Function to Gather Multiple Stratified Variables into a Tidy Format — gather_strat_multi_variable

<dl>

<dt>df</dt>
<dd>A data frame with variables stratified using numeric labels.</dd>


<dt>id_col</dt>
<dd>A character string containing the name of the new id column.</dd>


<dt>compartments</dt>
<dd>A character vector specifying the unique population compartments.</dd>


<dt>hold_out_var</dt>
<dd>A character vector specifying the variables to keep unchanged. Defaults to NULL</dd>


<dt>strat</dt>
<dd>An integer specifying the number of stratifications to reduce.</dd>


<dt>groups</dt>
<dd>A character vector with length equal to the level of stratification.
Used to name the stratified levels.</dd>

</dl>

gather_strat_multi_variable: A Function to Gather Multiple Stratified Variables into a Tidy Format

Description

Usage

Value

Arguments

Examples