sagang_lakeflood: QGIS algorithm - Lake flood

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

QGIS algorithm - Lake flood

Description

QGIS Algorithm provided by SAGA Next Gen Lake flood (sagang:lakeflood). —————- Arguments —————- ELEV: DEM Argument type: raster Acceptable values: - Path to a raster layer SEEDS: Seeds Argument type: raster Acceptable values: - Path to a raster layer LEVEL: Absolute Water Levels Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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 OUTDEPTH: Lake Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTLEVEL: Surface Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

sagang_lakeflood(
  ELEV = qgisprocess:::qgis_default_value(),
  SEEDS = qgisprocess:::qgis_default_value(),
  LEVEL = qgisprocess:::qgis_default_value(),
  OUTDEPTH = qgisprocess:::qgis_default_value(),
  OUTLEVEL = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ELEV	raster - DEM. Path to a raster layer.
SEEDS	raster - Seeds. Path to a raster layer.
LEVEL	boolean - Absolute Water Levels. 1 for true/yes. 0 for false/no. 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.
OUTDEPTH	rasterDestination - Lake. Path for new raster layer.
OUTLEVEL	rasterDestination - Surface. Path for new raster layer.
...	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

• OUTDEPTH - outputRaster - Lake

• OUTLEVEL - outputRaster - Surface

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