rsaga.html.help {RSAGA}R Documentation

HTML help on a SAGA module or library

Description

This function tries to obtain SAGA's HTML help for the specified library or module. NOTE: HTML help files are not provided with all SAGA distributions.

Usage

rsaga.html.help(lib, module, env = rsaga.env(), ...)

Arguments

lib name of the SAGA library, or one of the rsaga. module functions such as rsaga.hillshade
module name or numeric identifier of SAGA module in library lib; module=NULL links to the main help page of the SAGA library lib
env list, setting up a SAGA geoprocessing environment as created by rsaga.env
... additional arguments to be passed to browseURL

Details

Doesn't seem to work with SAGA GIS 2.0.2+, needs to be updated, sorry. Please use rsaga.get.usage or rsaga.search.modules or rsaga.get.modules instead.

Deprecated details on this function: This help is not always available, there are some mismatches between libraries and their HTML files, and the HTML files are designed for use with SAGA GUI, not with the command line version. Some HTML help pages are also linked to the wrong module; in this case the SAGA library's help page may provide a link to the module's help page.

In many cases rsaga.get.usage will provide more reliable information.

Author(s)

Alexander Brenning

See Also

rsaga.get.usage, rsaga.geoprocessor, rsaga.env, browseURL

Examples

## Not run: rsaga.html.help(rsaga.parallel.processing)

[Package RSAGA version 0.9-4 Index]