apsimx (version 2.8.0)

apsimx_options: Setting some options for the package

Description

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

Usage

apsimx_options(
  exe.path = NA,
  dotnet = FALSE,
  mono = FALSE,
  examples.path = NA,
  warn.versions = TRUE,
  warn.find.apsimx = TRUE,
  allow.path.spaces = FALSE
)

Value

as a side effect it modifies the ‘apsimx.options’ environment.

Arguments

exe.path

path to apsim executable. White spaces are not allowed.

dotnet

logical indicating if APSIM should be run through the dotnet command

mono

logical indicating if the mono command should be used when running APSIM. This is for versions for Mac/Linux older than Sept 2021.

examples.path

path to apsim examples

warn.versions

logical. warning if multiple versions of APSIM-X are detected.

warn.find.apsimx

logical. By default a warning will be thrown if APSIM-X is not found. If ‘exe.path’ is ‘NA’ an error will be thrown instead.

allow.path.spaces

logical. By default spaces are not allowed in paths or in the run command.

Details

Set apsimx options

Examples

# \donttest{
names(apsimx.options)
apsimx_options(exe.path = "some-new-path-to-executable")
apsimx.options$exe.path
# }