Read samrat predictor data — samrat_read

Reads predictors from formatted samrat predictors file. TODO: Link here to correct format for a predictors file

samrat_read_predictors(predictors_file, pars_list, check = TRUE)

Arguments

predictors_file: Name of predictors file
pars_list: Parameter outputs from samrat_read_params()
check: Boolean for whether to check the output. Default = TRUE

Value

Returns a list with 3 elements:

"demog_pars""Demography parameters list"
"pop_sources""Population source list of data.frames"
"dictionary""Demography Dictionary data.frame"

Details

samrat_read_predictors Read samrat predictors

Examples

{

param_file <- system.file(
"extdata/som_analysis_parameters.xlsx", package = "samrat"
)
pars_list <- samrat_read_params(param_file)

predictors_file <- system.file(
"extdata/som_predictor_data.xlsx", package = "samrat"
)
predictors_list <- samrat_read_predictors(predictors_file, pars_list)
names(predictors_list)

}
#> [1] "predictors_list"    "predictors"         "manual_imputations"
#> [4] "dictionary"