define_hisafe_file: Define a Hi-sAFe experiment from a file

In kevinwolz/hisafer: An R Toolbox for the Hi-sAFe Biophysical Agroforestry Model

Description

Defines a Hi-sAFe experiment - the input parameters to one or more Hi-sAFe simulations. define_hisafe_file cannot handle parameters that require numeric vectors or are within parameters tables. Use define_hisafe instead.

Usage

define_hisafe_file(
  file,
  path,
  exp.name = "experiment",
  profiles = "all",
  template = "agroforestry",
  force = FALSE
)

Arguments

file	A character string of the path to a csv file. Each row in the file should represent a Hi-sAFe simulation and each column a Hi-sAFe input parameter. For more information on supported parameters, use hip_params.
path	A character string of the path (relative or absolute) to the directory where the simulation/experiment is to be built.
exp.name	A character string of the name of the experiment folder. Only used if defining more than one simulation.
profiles	A character vector of Hi-sAFe export profiles to be exported by Hi-sAFe. If "all" (the default), then all supported profiles will be exported.
template	A character string of the path to the directory containing the template set of Hi-sAFe simulation folders/files to use. See define_hisafe for more details.
force	Logical indicating wether the supplied values should be forced past the constraint checks. Use TRUE for development only. See define_hisafe for more details.

Details

It is strongly recommended to name each simulation in your experiment. This can be done via the SimulationName parameter. If no names are provided, then generic names of "Sim_1", "Sim_2", etc. will be generated.

Value

An object of class "hip". See define_hisafe for more details.

See Also

Other hisafe definition functions: define_hisafe(), layer_init_params(), layer_params(), root_init_params(), tree_init_params(), variety_params()

Examples

## Not run: 
# To define a Hi-sAFe experiment from a file:
myexp <- define_hisafe_file("./example_exp.csv")

## End(Not run)

kevinwolz/hisafer documentation built on Oct. 19, 2020, 4:43 p.m.