Note: This vignette is illustrated with fake data. The dataset explored in this example should not be used to inform decision-making.
This is a placeholder vignette that demonstrates the three illustrative functions that are bundled with the initial development version of the avert library.
Identify the publicly available project repositories
The get_project_repos function retrieves the names of
publicly available repos in in the avertableburden GitHub
organisation.
## [1] "avert" "avert_report" ".github" "avertui"Retrieve publicly available model parameters
The get_input_data function retrieves a list object that
stores (currently, placeholder) model parameter values from the public Dataverse
dataset.
parameters_ls <- get_input_data()The get_parameter_value function retrieves the values of
named parameters from the parameter values list.
get_parameter_value("first", parameters_ls)## [1] 5
get_parameter_value("second", parameters_ls)## [1] 6Render report
The write_report function retrieves a reporting template
and passes the parameters list to that template to generate a
report.
write_avert_report(parameters_ls)