sagang_diffusepollutionrisk: QGIS algorithm - Diffuse pollution risk

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

QGIS algorithm - Diffuse pollution risk

Description

QGIS Algorithm provided by SAGA Next Gen Diffuse pollution risk (sagang:diffusepollutionrisk). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer CHANNEL: Channel Network (optional) Argument type: raster Acceptable values: - Path to a raster layer WEIGHT: Land Cover Weights (optional) Argument type: raster Acceptable values: - Path to a raster layer WEIGHT_DEFAULT: Default 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 RAIN: Rainfall (optional) Argument type: raster Acceptable values: - Path to a raster layer RAIN_DEFAULT: Default Default value: 500 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 DELIVERY: Delivery Index Argument type: rasterDestination Acceptable values: - Path for new raster layer RISK_POINT: Locational Risk Argument type: rasterDestination Acceptable values: - Path for new raster layer RISK_DIFFUSE: Diffuse Pollution Risk Argument type: rasterDestination Acceptable values: - Path for new raster layer METHOD: Flow Routing Default value: 1 Argument type: enum Available values: - 0: (0) D8 - 1: (1) MFD Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' CHANNEL_START: Channel Initiation Threshold Default value: 150 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_diffusepollutionrisk(
  DEM = qgisprocess:::qgis_default_value(),
  CHANNEL = qgisprocess:::qgis_default_value(),
  WEIGHT = qgisprocess:::qgis_default_value(),
  WEIGHT_DEFAULT = qgisprocess:::qgis_default_value(),
  RAIN = qgisprocess:::qgis_default_value(),
  RAIN_DEFAULT = qgisprocess:::qgis_default_value(),
  DELIVERY = qgisprocess:::qgis_default_value(),
  RISK_POINT = qgisprocess:::qgis_default_value(),
  RISK_DIFFUSE = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  CHANNEL_START = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM	raster - Elevation. Path to a raster layer.
CHANNEL	raster - Channel Network. Path to a raster layer.
WEIGHT	raster - Land Cover Weights. Path to a raster layer.
WEIGHT_DEFAULT	number - Default. 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.
RAIN	raster - Rainfall. Path to a raster layer.
RAIN_DEFAULT	number - Default. 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.
DELIVERY	rasterDestination - Delivery Index. Path for new raster layer.
RISK_POINT	rasterDestination - Locational Risk. Path for new raster layer.
RISK_DIFFUSE	rasterDestination - Diffuse Pollution Risk. Path for new raster layer.
METHOD	enum of ⁠("(0) D8", "(1) MFD")⁠ - Flow Routing. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
CHANNEL_START	number - Channel Initiation Threshold. 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

• DELIVERY - outputRaster - Delivery Index

• RISK_DIFFUSE - outputRaster - Diffuse Pollution Risk

• RISK_POINT - outputRaster - Locational Risk

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