growR_run_loop: Run growR simulations

View source: R/run.R

growR_run_loopR Documentation

Run growR simulations

Description

Start the loop over runs specified in the config file.

Usage

growR_run_loop(modvege_environments, output_dir = "", independent = TRUE)

Arguments

modvege_environments

A list of ModvegeEnvironment instances.

output_dir

string; name of directory to which output files are to be written. If output_dir == "" (default), no files are written.

independent

boolean; If TRUE (default) the simulation for each year starts with the same initial conditions, as specified in the parameters of the modvege_environments. If FALSE, initial conditions are taken as the final state values of the simulation of the previous year.

Details

By default, returns an empty list but writes output to the output files as specified in the site_name and run_name fields of the supplied ModvegeEnvironment instances. Change this behaviour through the write_files and store_results arguments.

Value

A list of the format ⁠[[run]][[year]]⁠ containing clones of the ModvegeSite instances that were run. Also write to files, if output_dir is nonempty.

Examples

env1 = create_example_environment(site = "posieux")
env2 = create_example_environment(site = "sorens")

growR_run_loop(c(env1, env2), output_dir = "")


growR documentation built on May 29, 2024, 9:12 a.m.