sagang_successiveflowrouting: QGIS algorithm - Successive flow routing

View source: R/sagang_successiveflowrouting.R

sagang_successiveflowroutingR Documentation

QGIS algorithm - Successive flow routing

Description

QGIS Algorithm provided by SAGA Next Gen Successive flow routing (sagang:successiveflowrouting). —————- Arguments —————- DEM: DEM Argument type: raster Acceptable values: - Path to a raster layer FLOW: Flow Argument type: rasterDestination Acceptable values: - Path for new raster layer ITERATIONS: Iterations Default value: 100 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 RUNOFF: Runoff Default value: 1 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 MANNING: Manning's Roughness Default value: 0.2 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_successiveflowrouting(
  DEM = qgisprocess:::qgis_default_value(),
  FLOW = qgisprocess:::qgis_default_value(),
  ITERATIONS = qgisprocess:::qgis_default_value(),
  RUNOFF = qgisprocess:::qgis_default_value(),
  MANNING = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM

raster - DEM. Path to a raster layer.

FLOW

rasterDestination - Flow. Path for new raster layer.

ITERATIONS

number - Iterations. 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.

RUNOFF

number - Runoff. 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.

MANNING

number - Manning's Roughness. 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

  • FLOW - outputRaster - Flow


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