apsimx_options: Setting some options for the package

In apsimx: Inspect, Read, Edit and Run 'APSIM' "Next Generation" and 'APSIM' Classic

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
)

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

Value

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

Note

It is possible that APSIM-X 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-X are installed apsimx will choose the newest one but it will issue a warning. Suppress the warning by setting warn.versions = FLASE.

Examples

names(apsimx.options)
apsimx_options(exe.path = "some-new-path-to-executable")
apsimx.options$exe.path

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