sagang_massbalanceindex: QGIS algorithm - Mass balance index

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

QGIS algorithm - Mass balance index

Description

QGIS Algorithm provided by SAGA Next Gen Mass balance index (sagang:massbalanceindex). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer HREL: Vertical Distance to Channel Network (optional) Argument type: raster Acceptable values: - Path to a raster layer MBI: Mass Balance Index Argument type: rasterDestination Acceptable values: - Path for new raster layer TSLOPE: T Slope Default value: 15 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 TCURVE: T Curvature Default value: 0.01 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 THREL: T Vertical Distance to Channel Network Default value: 15 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_massbalanceindex(
  DEM = qgisprocess:::qgis_default_value(),
  HREL = qgisprocess:::qgis_default_value(),
  MBI = qgisprocess:::qgis_default_value(),
  TSLOPE = qgisprocess:::qgis_default_value(),
  TCURVE = qgisprocess:::qgis_default_value(),
  THREL = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM	raster - Elevation. Path to a raster layer.
HREL	raster - Vertical Distance to Channel Network. Path to a raster layer.
MBI	rasterDestination - Mass Balance Index. Path for new raster layer.
TSLOPE	number - T Slope. 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.
TCURVE	number - T Curvature. 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.
THREL	number - T Vertical Distance to Channel Network. 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

• MBI - outputRaster - Mass Balance Index

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