verify_config: Verifies if all required config fields are provided

View source: R/config_handling.R

verify_configR Documentation

Verifies if all required config fields are provided

Description

Verifies if all required config fields are provided

Usage

verify_config(config)

Arguments

config

a config object

Value

Returns TRUE for a valid config, FALSE otherwise, in which case a list of missing parameters will be printed out as well

See Also

create_input_config write_config_skeleton

Examples

# get path to input config
datapath <- system.file(file.path("extdata", "WorldCenter"), package="gen3sis")
path_config <- file.path(datapath, "config/config_worldcenter.R")
# create config object
config_object <- create_input_config(path_config)
# check class
class(config_object)
# verify config
verify_config(config_object) # TRUE! this is a valid config

# break config_object, change name random_seed to r4nd0m_s33d
names(config_object$gen3sis$general)[1] <- "r4nd0m_s33d"
verify_config(config_object) # FALSE! this is an invalid config

gen3sis documentation built on Nov. 22, 2023, 5:07 p.m.