generate_stratifier_list: Produce a default stratifier list for use with the...
In andreashandel/modelbuilder: Building Compartmental Simulation Models Without Coding
View source: R/generate_stratifier_list.R
generate_stratifier_list R Documentation
Produce a default stratifier list for use with the generate_stratification function
Description
The model needs to adhere to the structure specified by
the modelbuilder package. Models built using the modelbuilder package
automatically have the right structure. A user can also build a
model list structure themselves following the modelbuilder
specifications. If the user provides a file name, this file needs to
be an RDS file and contain a valid modelbuilder model structure.
Usage
generate_stratifier_list(mbmodel)
Arguments
mbmodel
modelbuilder model structure, either as list object
or file name
Details
This function takes as input a modelbuilder model and
returns a list of all parameters and the variables by which to stratify
the default is to stratify by each variable that shows up in a flow for that parameter
Value
The function returns a stratifier object (a list).
Author(s)
Andrew Tredennick and Andreas Handel
andreashandel/modelbuilder documentation built on April 16, 2024, 8:48 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/generate_stratifier_list.R
| generate_stratifier_list | R Documentation |
Produce a default stratifier list for use with the generate_stratification function
Description
The model needs to adhere to the structure specified by the modelbuilder package. Models built using the modelbuilder package automatically have the right structure. A user can also build a model list structure themselves following the modelbuilder specifications. If the user provides a file name, this file needs to be an RDS file and contain a valid modelbuilder model structure.
Usage
generate_stratifier_list(mbmodel)
Arguments
mbmodel |
modelbuilder model structure, either as list object or file name |
Details
This function takes as input a modelbuilder model and returns a list of all parameters and the variables by which to stratify the default is to stratify by each variable that shows up in a flow for that parameter
Value
The function returns a stratifier object (a list).
Author(s)
Andrew Tredennick and Andreas Handel
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.