rsaga.get.modules {RSAGA} | R Documentation |
These functions list the SAGA libraries
(rsaga.get.libraries
) and modules (rsaga.get.lib.modules
,
rsaga.get.modules
) available in a SAGA installation,
and allow to perform a full-text search among these
functions.
rsaga.get.libraries(path = rsaga.env()$modules, dll = .Platform$dynlib.ext) rsaga.get.lib.modules(lib, env = rsaga.env(), interactive = FALSE) rsaga.get.modules(libs, env = rsaga.env(), ...) rsaga.search.modules(text, modules, search.libs = TRUE, search.modules = TRUE, env = rsaga.env(), ignore.case = TRUE, ...)
text |
character string to be searched for in the names of available libraries and/or modules |
search.libs, search.modules |
logical (default
TRUE : should text be searched for in
library and/or module names? |
ignore.case |
logical (default FALSE ): should
the text search in library/module names be
case sensitive? |
lib, libs |
character vector (libs ) or character
string (lib ) with the name(s) of library/ies in
which to look for modules; if libs is missing,
all libraries will be processed |
modules |
optional list:
result of rsaga.get.modules ; if missing,
a list of available modules will be retrieved using
that function |
env |
list, setting up a SAGA geoprocessing environment
as created by rsaga.env |
path |
path of SAGA library files (modules subfolder
in the SAGA installation folder); defaults to the
path determined by rsaga.env . |
dll |
file extension of dynamic link libraries |
interactive |
logical (default FALSE ): should
modules be returned that can only be executed in
interactive mode (i.e. using SAGA GUI)? |
... |
currently only interactive to be passed on
to rsaga.get.lib.modules |
rsaga.get.libraries
returns a character vector with the
names of all SAGA libraries available in the folder
env$modules
.
rsaga.get.lib.modules
returns a data.frame
with:
name |
the names of all modules in library lib , |
code |
their numeric identifiers, |
interactive |
and a logical variable indicating whether a module can only be executed in interactive (SAGA GUI) mode. |
rsaga.get.modules
returns a list with, for each SAGA
library in libs
, a data.frame
with module information
as given by rsaga.get.lib.modules
. If libs
is missing,
all modules in all libraries will be retrieved.
For information on the usage of SAGA command line modules,
see rsaga.get.usage
(or rsaga.html.help
),
or the RSAGA interface function, if available.
Alexander Brenning
rsaga.get.usage
, rsaga.html.help
,
rsaga.geoprocessor
, rsaga.env
## Not run: # make sure that 'rsaga.env' can find 'saga_cmd.exe' # before running this: rsaga.get.libraries() # list all modules in my favorite libraries: rsaga.get.modules(c("io_grid", "grid_tools", "ta_preprocessor", "ta_morphometry", "ta_lighting", "ta_hydrology")) # list *all* modules (quite a few!): # rsaga.get.modules(interactive=TRUE) # find modules that remove sink from DEMs: rsaga.search.modules("sink") # find modules that close gaps (no-data areas) in grids: rsaga.search.modules("gap") ## End(Not run)