Skip to contents

read_results() reads the results.qs2 of one scenario, the file that save_results() or run_scenarios() writes. The default reads the real results.

Usage

read_results(version, scenario = "real", sim = NULL, home = ".")

Arguments

version

The version, for example "v01".

scenario

The scenario. The default is "real".

sim

NULL, or the number of one simulation.

home

The project folder.

Value

The results object, a named list. See save_results().

Details

With sim = NULL, read_results() reads <home>/<version>_results/<scenario>/results.qs2. That is the results of a scenario with 1 simulation, or the simulations that run_scenarios() stacked. With a number k, it reads <home>/<version>_results/<scenario>/sim_<kkkk>/results.qs2, where <kkkk> is k with four digits.

A manuscript MUST read the real results only. check_project() fails a call in manuscript/built/ that gives a scenario other than "real".

See also

Examples

# See the example of save_results().