sagang_watershedbasins: QGIS algorithm - Watershed basins

View source: R/sagang_watershedbasins.R

sagang_watershedbasinsR Documentation

QGIS algorithm - Watershed basins

Description

QGIS Algorithm provided by SAGA Next Gen Watershed basins (sagang:watershedbasins). —————- Arguments —————- ELEVATION: Elevation Argument type: raster Acceptable values: - Path to a raster layer CHANNELS: Channel Network Argument type: raster Acceptable values: - Path to a raster layer SINKROUTE: Sink Route (optional) Argument type: raster Acceptable values: - Path to a raster layer BASINS: Watershed Basins Argument type: rasterDestination Acceptable values: - Path for new raster layer MINSIZE: Min. Size Default value: 0 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_watershedbasins(
  ELEVATION = qgisprocess:::qgis_default_value(),
  CHANNELS = qgisprocess:::qgis_default_value(),
  SINKROUTE = qgisprocess:::qgis_default_value(),
  BASINS = qgisprocess:::qgis_default_value(),
  MINSIZE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ELEVATION

raster - Elevation. Path to a raster layer.

CHANNELS

raster - Channel Network. Path to a raster layer.

SINKROUTE

raster - Sink Route. Path to a raster layer.

BASINS

rasterDestination - Watershed Basins. Path for new raster layer.

MINSIZE

number - Min. Size. 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

  • BASINS - outputRaster - Watershed Basins


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