sagang_lsfactoronestep: QGIS algorithm - Ls factor (one step)

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

QGIS algorithm - Ls factor (one step)

Description

QGIS Algorithm provided by SAGA Next Gen Ls factor (one step) (sagang:lsfactoronestep). —————- Arguments —————- DEM: DEM Argument type: raster Acceptable values: - Path to a raster layer LS_FACTOR: LS Factor Argument type: rasterDestination Acceptable values: - Path for new raster layer LS_METHOD: Method Default value: 0 Argument type: enum Available values: - 0: (0) Moore et al. 1991 - 1: (1) Desmond & Govers 1996 Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' PREPROCESSING: Preprocessing Default value: 2 Argument type: enum Available values: - 0: (0) none - 1: (1) Fill Sinks (Wang & Liu) - 2: (2) Sink Removal Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' MINSLOPE: Minimum Slope Default value: 0.0001 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression

Usage

sagang_lsfactoronestep(
  DEM = qgisprocess:::qgis_default_value(),
  LS_FACTOR = qgisprocess:::qgis_default_value(),
  LS_METHOD = qgisprocess:::qgis_default_value(),
  PREPROCESSING = qgisprocess:::qgis_default_value(),
  MINSLOPE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM	raster - DEM. Path to a raster layer.
LS_FACTOR	rasterDestination - LS Factor. Path for new raster layer.
LS_METHOD	enum of ⁠("(0) Moore et al. 1991", "(1) Desmond & Govers 1996")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
PREPROCESSING	enum of ⁠("(0) none", "(1) Fill Sinks (Wang & Liu)", "(2) Sink Removal")⁠ - Preprocessing. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
MINSLOPE	number - Minimum Slope. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
...	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

• LS_FACTOR - outputRaster - LS Factor

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