sagang_maximumflowpathlength: QGIS algorithm - Maximum flow path length

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

QGIS algorithm - Maximum flow path length

Description

QGIS Algorithm provided by SAGA Next Gen Maximum flow path length (sagang:maximumflowpathlength). —————- Arguments —————- ELEVATION: Elevation Argument type: raster Acceptable values: - Path to a raster layer WEIGHTS: Weights (optional) Argument type: raster Acceptable values: - Path to a raster layer DISTANCE: Flow Path Length Argument type: rasterDestination Acceptable values: - Path for new raster layer DIRECTION: Direction of Measurement Default value: 0 Argument type: enum Available values: - 0: (0) downstream - 1: (1) upstream Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_maximumflowpathlength(
  ELEVATION = qgisprocess:::qgis_default_value(),
  WEIGHTS = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  DIRECTION = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ELEVATION	raster - Elevation. Path to a raster layer.
WEIGHTS	raster - Weights. Path to a raster layer.
DISTANCE	rasterDestination - Flow Path Length. Path for new raster layer.
DIRECTION	enum of ⁠("(0) downstream", "(1) upstream")⁠ - Direction of Measurement. 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

• DISTANCE - outputRaster - Flow Path Length

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