apsim_options: Setting some options specific to APSIM (7.x) 'Classic'

View source: R/apsim_classic.R

apsim_optionsR Documentation

Setting some options specific to APSIM (7.x) ‘Classic’

Description

Set the path to the APSIM executable, examples and warning suppression.

Usage

apsim_options(exe.path = NA, examples.path = NA, warn.versions = TRUE)

Arguments

exe.path

path to apsim executable

examples.path

path to apsim examples

warn.versions

logical. warning if multiple versions of APSIM are detected.

Details

Set apsim options

Value

It modifies the ‘apsim.options’ environment as a side effect.

Note

It is possible that APSIM 7.x ‘Classic’ is installed in some alternative location other than the defaults ones. Guessing this can be difficult and then the auto_detect functions might fail. Also, if multiple versions of APSIM are installed apsim will choose the newest one but it will issue a warning. Suppress the warning by setting warn.versions = FLASE.

Examples

## Not run: 
names(apsim.options)
apsim_options(exe.path = "some-new-path-to-executable")
apsim.options$exe.path

## End(Not run)

apsimx documentation built on Sept. 11, 2024, 5:42 p.m.