rsaga.get.usage {RSAGA}R Documentation

Usage of SAGA command line modules

Description

rsaga.get.usage provides information on the usage of and arguments required by SAGA command line modules.

Usage

rsaga.get.usage(lib, module, env = rsaga.env(), show = TRUE)

Arguments

lib name of the SAGA library
module name or numeric identifier of SAGA module in library lib
env list, setting up a SAGA geoprocessing environment as created by rsaga.env
show logical (default: TRUE; display usage on R console?

Details

This funciton is intended to provide information required to use the rsaga.geoprocessor and for writing your own high-level interface function for SAGA modules. R–SAGA interfaces already exist for some SAGA modules, e.g. rsaga.hillshade, rsaga.local.morphometry. For information on the usage and arguments

Value

The character vector with usage information is invisibly returned.

Author(s)

Alexander Brenning

See Also

rsaga.geoprocessor, rsaga.env, rsaga.html.help

Examples

## Not run: 
rsaga.get.usage("io_grid",1)
rsaga.get.usage("ta_preprocessor",2)
rsaga.get.usage("ta_morphometry",0)
## End(Not run)

[Package RSAGA version 0.9-5 Index]