Description Usage Arguments Value Note See Also Examples
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.
1 2 3 4 5 6 7 8 9 10 11 | rsaga.get.modules(libs, env = rsaga.env(), interactive = FALSE,
parallel = env$parallel)
rsaga.get.libraries(path = rsaga.env()$modules, dll)
rsaga.get.lib.modules(lib, env = rsaga.env(), interactive = FALSE)
rsaga.module.exists(libs, module, env = rsaga.env(), ...)
rsaga.search.modules(text, modules, search.libs = TRUE,
search.modules = TRUE, env = rsaga.env(), ignore.case = TRUE, ...)
|
libs |
character vector with the names of libraries in which to look for modules; if missing, all libraries will be processed |
env |
a SAGA geoprocessing environment as created by |
interactive |
logical (default |
parallel |
logical (defaults to |
path |
path of SAGA library files ( |
dll |
file extension of dynamic link libraries |
lib |
character string with the name of the library in which to look for modules |
module |
module name or numeric code |
... |
currently only |
text |
character string to be searched for in the names of available libraries and/or modules |
modules |
optional list: result of |
search.libs |
logical (default |
search.modules |
logical (default |
ignore.case |
logical (default |
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
(in SAGA GIS 2.1.0+), or the RSAGA interface function, if available.
rsaga.get.usage
, rsaga.html.help
, rsaga.geoprocessor
, rsaga.env
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | ## 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)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.