rmacroliteSetModelVar-methods: Set the absolute path of the folder in which MACRO (or MACRO...

In julienmoeys/rmacrolite: R interface for the pesticide fate models MACRO In FOCUS and MACRO

Description

Set the absolute path of the folder in which MACRO (or MACRO In FOCUS) executable is installed. as well as the name of MACRO executable and the name of the exeparfile executable.

Regarding the path to MACRO-folder, the function proceeds as follow: If a value is given (argument codepath, see below), it is used to set MACRO-path in the package-option macro_path (see rmlPar), value that is then used by other function in this package. If no value is given (argument codepath left to NULL), the function will first search for a Windows Environment Variable (System Variable) called rmacrolite_macro_path, and use this value if it exists, to set macro_path in rmlPar. See rmacrolite-system-variables. Finally, if neither the argument codepath is set, nor a System Variable called rmacrolite_macro_path, the function will try the factory-default path to MACRO In FOCUS (type getRmlPar("macro_path_default") to find out).

The principle is the same for MACRO executable (argument exe, System Variable rmacrolite_macro_exe, factory default set in getRmlPar("macro_exe_default")) as well as for the exeparfile executable (argument exeparfile, System Variable rmacrolite_macro_exeparfile, factory default set in getRmlPar("macro_exeparfile_default")).

Usage

rmacroliteSetModelVar(path = NULL, exe = NULL, exeparfile = NULL,
  ...)

## Default S3 method:
rmacroliteSetModelVar(path = NULL, exe = NULL,
  exeparfile = NULL, ...)

Arguments

path	Single character string. Absolute path to the folder (directory) in which MACRO or MACRO In FOCUS executable can be found. When both programs are installed on your computer, chose which of the two you want rmacrolite to use. Do not include the name of the executable, only its folder. See the introduction above.
exe	Single character string. Name, without path, but with the extension, of the MACRO or MACRO In FOCUS executable to be used by rmacrolite. The executable must be present in the folder path. See the introduction above.
exeparfile	Single character string. Name, without path, but with the extension, of the exeparfile executable to be used by rmacrolite. The executable must be present in the folder path. As it is currently not shipped with MACRO, the user must install the executable beforehand. It can be copy-pasted from a MACRO In FOCUS installation. See the introduction above.
...	Additional parameters passed to specific methods.

Value

Invisibly returns a list with 3 named items: path, exe and exeparfile, set to the values found out by the function.

See Also

rmacroliteGetModelVar and rmacrolite-system-variables.

Examples

# # Not run
# rmacroliteSetModelVar( path = "C:/swash/macro" )

julienmoeys/rmacrolite documentation built on May 22, 2019, 6:31 p.m.