sagang_fillsinkswangliu: QGIS algorithm - Fill sinks (wang & liu)

View source: R/sagang_fillsinkswangliu.R

sagang_fillsinkswangliuR Documentation

QGIS algorithm - Fill sinks (wang & liu)

Description

QGIS Algorithm provided by SAGA Next Gen Fill sinks (wang & liu) (sagang:fillsinkswangliu). —————- Arguments —————- ELEV: DEM Argument type: raster Acceptable values: - Path to a raster layer FILLED: Filled DEM Argument type: rasterDestination Acceptable values: - Path for new raster layer FDIR: Flow Directions Argument type: rasterDestination Acceptable values: - Path for new raster layer WSHED: Watershed Basins Argument type: rasterDestination Acceptable values: - Path for new raster layer MINSLOPE: Minimum Slope (Degree) Default value: 0.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

Usage

sagang_fillsinkswangliu(
  ELEV = qgisprocess:::qgis_default_value(),
  FILLED = qgisprocess:::qgis_default_value(),
  FDIR = qgisprocess:::qgis_default_value(),
  WSHED = qgisprocess:::qgis_default_value(),
  MINSLOPE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ELEV

raster - DEM. Path to a raster layer.

FILLED

rasterDestination - Filled DEM. Path for new raster layer.

FDIR

rasterDestination - Flow Directions. Path for new raster layer.

WSHED

rasterDestination - Watershed Basins. Path for new raster layer.

MINSLOPE

number - Minimum Slope (Degree). 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

  • FDIR - outputRaster - Flow Directions

  • FILLED - outputRaster - Filled DEM

  • WSHED - outputRaster - Watershed Basins


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