sagang_topographicwetnessindexonestep: QGIS algorithm - Topographic wetness index (one step)

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - Topographic wetness index (one step)

Description

QGIS Algorithm provided by SAGA Next Gen Topographic wetness index (one step) (sagang:topographicwetnessindexonestep). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer TWI: Topographic Wetness Index Argument type: rasterDestination Acceptable values: - Path for new raster layer FLOW_METHOD: Flow Distribution Default value: 4 Argument type: enum Available values: - 0: (0) Deterministic 8 - 1: (1) Rho 8 - 2: (2) Braunschweiger Reliefmodell - 3: (3) Deterministic Infinity - 4: (4) Multiple Flow Direction - 5: (5) Multiple Triangular Flow Direction - 6: (6) Multiple Maximum Downslope Gradient Based Flow Direction Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_topographicwetnessindexonestep(
  DEM = qgisprocess:::qgis_default_value(),
  TWI = qgisprocess:::qgis_default_value(),
  FLOW_METHOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM	raster - Elevation. Path to a raster layer.
TWI	rasterDestination - Topographic Wetness Index. Path for new raster layer.
FLOW_METHOD	enum of ⁠("(0) Deterministic 8", "(1) Rho 8", "(2) Braunschweiger Reliefmodell", "(3) Deterministic Infinity", "(4) Multiple Flow Direction", "(5) Multiple Triangular Flow Direction", "(6) Multiple Maximum Downslope Gradient Based Flow Direction")⁠ - Flow Distribution. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
...	further parameters passed to qgisprocess::qgis_run_algorithm()
.complete_output	logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.
.quiet	logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.
.messages	logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

• TWI - outputRaster - Topographic Wetness Index

JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.