RSAGA (version 1.4.0)

rsaga.html.help: HTML help on a SAGA module or library

Description

This function opens SAGA's HTML documentation for the specified library or module. Works with SAGA GIS 2.1.0(+), for earlier versions a web page with the SAGA GIS wiki is displayed.

Usage

rsaga.html.help(
  lib,
  module = NULL,
  use.program.folder = TRUE,
  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 takes you to the main help page of the SAGA library lib

use.program.folder

logical; if TRUE (the default), attempt to write SAGA GIS documentation to a "help" subfolder of env$path; the "help" folder is created if it doesn't exist. If FALSE, create SAGA GIS documentation files in this R session's temporary folder as obtained using tempdir()

env

a SAGA geoprocessing environment as created by rsaga.env()

...

additional arguments to browseURL()

Details

Requires SAGA GIS 2.1.0(+), with earlier versions use rsaga.get.usage().

See Also

rsaga.get.usage(), rsaga.geoprocessor(), rsaga.env()

Examples

if (FALSE) {
# Requires SAGA GIS 2.1.0+:
rsaga.html.help("io_grid")
rsaga.html.help("io_grid",0)
rsaga.html.help("io_grid","Import ESRI Arc/Info Grid")
}