R6 class to handle MetaRVM configuration data with validation and methods.
This class encapsulates all configuration parameters needed for MetaRVM simulations,
providing methods for parameter access, validation, and introspection.
Details
The MetaRVMConfig class stores parsed configuration data from YAML files and provides
structured access to simulation parameters. It automatically validates configuration
completeness and provides convenient methods for accessing demographic categories,
initialization-derived population metadata, and other simulation settings.
Public fields
config_filePath to the original YAML config file (if applicable)
config_dataList containing all parsed configuration parameters
Methods
Method new()
Initialize a new MetaRVMConfig object
Arguments
inputEither a file path (character) or parsed config list
Returns
New MetaRVMConfig object (invisible)
Get a configuration parameter
Returns
The requested parameter value
Method get_all()
Get all configuration parameters as a list
Returns
Named list of all configuration parameters
Method list_parameters()
List all available parameter names
Usage
MetaRVMConfig$list_parameters()
Returns
Character vector of parameter names
Method parameter_summary()
Show summary of parameter types and sizes
Usage
MetaRVMConfig$parameter_summary()
Returns
Data frame with parameter information
Method set()
Set a configuration parameter
Usage
MetaRVMConfig$set(param, value)
Arguments
paramCharacter string. Parameter name to set
valueThe value to assign to the parameter
Returns
Self (invisible) for method chaining
Print summary of configuration
Method get_pop_map()
Get population mapping data
Usage
MetaRVMConfig$get_pop_map()
Returns
data.table containing population_id and user-defined demographic category columns
Method get_category_names()
Get names of all category columns
Usage
MetaRVMConfig$get_category_names()
Details
Category columns are automatically detected from the initialization CSV file.
Any column that is not a reserved column (population_id, N, S0, I0, R0, V0, etc.)
is treated as a demographic category (e.g., age, zone, income_level, occupation).
Returns
Character vector of category column names, or empty vector if no categories
Examples
\dontrun{
config <- MetaRVMConfig$new("config.yaml")
category_names <- config$get_category_names() # e.g., c("age", "zone", "risk_group")
}
Method get_category_values()
Get unique values for a specific category
Usage
MetaRVMConfig$get_category_values(category_name)
Arguments
category_nameCharacter string specifying the category name
Returns
Character/numeric vector of unique values for the specified category
Examples
\dontrun{
config <- MetaRVMConfig$new("config.yaml")
ages <- config$get_category_values("age") # if age is defined
income_levels <- config$get_category_values("income_level") # if defined
}
Method get_all_categories()
Get all categories as a named list
Usage
MetaRVMConfig$get_all_categories()
Returns
Named list where names are category column names and values are vectors
of unique values for each category. Returns empty list if no categories.
Examples
\dontrun{
config <- MetaRVMConfig$new("config.yaml")
all_cats <- config$get_all_categories()
# Returns: list(age = c("0-17", "18-64", "65+"), risk_group = c("low", "high"), ...)
}
Method clone()
The objects of this class are cloneable with this method.
Usage
MetaRVMConfig$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# Initialize from YAML file
example_config <- system.file("extdata", "example_config.yaml", package = "MetaRVM")
config <- MetaRVMConfig$new(example_config)
# Access parameters
config$get("N_pop")
#> [1] 24
config$get("start_date")
#> [1] "2023-09-30"
# Get demographic category names (user-defined)
category_names <- config$get_category_names() # e.g., c("age", "zone", "risk_group")
# Get values for specific categories
ages <- config$get_category_values("age")
# Get all categories as a named list
all_categories <- config$get_all_categories()
## ------------------------------------------------
## Method `MetaRVMConfig$get_category_names`
## ------------------------------------------------
if (FALSE) { # \dontrun{
config <- MetaRVMConfig$new("config.yaml")
category_names <- config$get_category_names() # e.g., c("age", "zone", "risk_group")
} # }
## ------------------------------------------------
## Method `MetaRVMConfig$get_category_values`
## ------------------------------------------------
if (FALSE) { # \dontrun{
config <- MetaRVMConfig$new("config.yaml")
ages <- config$get_category_values("age") # if age is defined
income_levels <- config$get_category_values("income_level") # if defined
} # }
## ------------------------------------------------
## Method `MetaRVMConfig$get_all_categories`
## ------------------------------------------------
if (FALSE) { # \dontrun{
config <- MetaRVMConfig$new("config.yaml")
all_cats <- config$get_all_categories()
# Returns: list(age = c("0-17", "18-64", "65+"), risk_group = c("low", "high"), ...)
} # }
