sagang_topographicwetnessindextwi: QGIS algorithm - Topographic wetness index (twi)

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

QGIS algorithm - Topographic wetness index (twi)

Description

QGIS Algorithm provided by SAGA Next Gen Topographic wetness index (twi) (sagang:topographicwetnessindextwi). —————- Arguments —————- SLOPE: Slope Argument type: raster Acceptable values: - Path to a raster layer AREA: Catchment Area Argument type: raster Acceptable values: - Path to a raster layer TRANS: Transmissivity (optional) Argument type: raster Acceptable values: - Path to a raster layer TWI: Topographic Wetness Index Argument type: rasterDestination Acceptable values: - Path for new raster layer CONV: Area Conversion Default value: 0 Argument type: enum Available values: - 0: (0) no conversion (areas already given as specific catchment area) - 1: (1) 1 / cell size (pseudo specific catchment area) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' METHOD: Method (TWI) Default value: 0 Argument type: enum Available values: - 0: (0) Standard - 1: (1) TOPMODEL Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_topographicwetnessindextwi(
  SLOPE = qgisprocess:::qgis_default_value(),
  AREA = qgisprocess:::qgis_default_value(),
  TRANS = qgisprocess:::qgis_default_value(),
  TWI = qgisprocess:::qgis_default_value(),
  CONV = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

SLOPE	raster - Slope. Path to a raster layer.
AREA	raster - Catchment Area. Path to a raster layer.
TRANS	raster - Transmissivity. Path to a raster layer.
TWI	rasterDestination - Topographic Wetness Index. Path for new raster layer.
CONV	enum of ⁠("(0) no conversion (areas already given as specific catchment area)", "(1) 1 / cell size (pseudo specific catchment area)")⁠ - Area Conversion. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
METHOD	enum of ⁠("(0) Standard", "(1) TOPMODEL")⁠ - Method (TWI). 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.