rsaga.set.env: Internal function that sets the RSAGA Geoprocessing...
In RSAGA: SAGA Geoprocessing and Terrain Analysis

rsaga.set.env

R Documentation

Internal function that sets the RSAGA Geoprocessing Evironment manually

Description

Internal function that sets the RSAGA Geoprocessing Evironment manually

Usage

rsaga.set.env(
  workspace = NULL,
  cmd = NULL,
  path = NULL,
  modules = NULL,
  version = NA,
  cores = NULL,
  parallel = NULL
)

Arguments

`workspace`	path of the working directory for SAGA; defaults to the current directory (`"."`).
`cmd`	name of the SAGA command line program; defaults to `saga_cmd.exe`, its name under Windows
`path`	path in which to find `cmd`; `rsaga.env` is usually able to find SAGA on your system if it is installed; see Details.
`modules`	path in which to find SAGA libraries; see Details
`version`	optional character string: SAGA GIS (API) version, e.g. `"2.0.8"`; if missing, a call to `rsaga.get.version()` is used to determine version number of SAGA API
`cores`	optional numeric argument, or `NA`: number of cores used by SAGA GIS; supported only by SAGA GIS 2.1.0 (and higher), ignored otherwise (with a warning). Multicore-enabled SAGA GIS modules such as the one used by `rsaga.pisr()` seem to run in multicore mode by default when this argument is not specified, therefore `cores` should only be specified to use a smaller number of cores than available on a machine.
`parallel`	optional logical argument (default: `FALSE`): if `TRUE`, run RSAGA functions that are capable of parallel processing in parallel mode; note that this is completely independent of the behaviour of SAGA GIS (which can be controlled using the `cores` argument); currently only some RSAGA functions support parallel processing (e.g., `pick.from.ascii.grid()` or `rsaga.get.modules()`). `parallel=TRUE` requires that a parallel backend such as doSNOW or doMC is available and has been started prior to calling any parallelized RSAGA function, otherwise warnings may be generated