sagang_shalstab: QGIS algorithm - Shalstab

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

QGIS algorithm - Shalstab

Description

QGIS Algorithm provided by SAGA Next Gen Shalstab (sagang:shalstab). —————- Arguments —————- A: Slope grid (rad) Argument type: raster Acceptable values: - Path to a raster layer B: Catchment area grid (m2) Argument type: raster Acceptable values: - Path to a raster layer Cmin: Min Density grid (g/cm3) (optional) Argument type: raster Acceptable values: - Path to a raster layer Cmax: Max Density grid (g/cm3) (optional) Argument type: raster Acceptable values: - Path to a raster layer Dmin: Min Hydraulic conductivity grid (m/hr) (optional) Argument type: raster Acceptable values: - Path to a raster layer Dmax: Max Hydraulic conductivity grid (m/hr) (optional) Argument type: raster Acceptable values: - Path to a raster layer Emin: Min Thickness grid (m) (optional) Argument type: raster Acceptable values: - Path to a raster layer Emax: Max Thickness grid (m) (optional) Argument type: raster Acceptable values: - Path to a raster layer Fmin: Min Friction angle grid (degree) (optional) Argument type: raster Acceptable values: - Path to a raster layer Fmax: Max Friction angle grid (degree) (optional) Argument type: raster Acceptable values: - Path to a raster layer Jmin: Min Bulk cohesion grid (MPa) (optional) Argument type: raster Acceptable values: - Path to a raster layer Jmax: Max Bulk cohesion grid (MPa) (optional) Argument type: raster Acceptable values: - Path to a raster layer fCmin: Global minimum density (g/cm3) Default value: 1.6 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 fCmax: Global maximum density (g/cm3) Default value: 1.6 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 fDmin: Global minimum conductivity (m/hr) Default value: 2.7 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 fDmax: Global maximum conductivity (m/hr) Default value: 2.7 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 fEmin: Global minimum thickness (m) 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 fEmax: Global maximum thickness (m) 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 fFmin: Global minimum friction angle (degree) Default value: 33 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 fFmax: Global maximum friction angle (degree) Default value: 33 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 fJmin: Global minimum bulk cohesion (MPa) 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 fJmax: Global maximum bulk cohesion (MPa) 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 fK: Parameter sampling runs 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 G: CR values Argument type: rasterDestination Acceptable values: - Path for new raster layer H: CR classes Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

sagang_shalstab(
  A = qgisprocess:::qgis_default_value(),
  B = qgisprocess:::qgis_default_value(),
  Cmin = qgisprocess:::qgis_default_value(),
  Cmax = qgisprocess:::qgis_default_value(),
  Dmin = qgisprocess:::qgis_default_value(),
  Dmax = qgisprocess:::qgis_default_value(),
  Emin = qgisprocess:::qgis_default_value(),
  Emax = qgisprocess:::qgis_default_value(),
  Fmin = qgisprocess:::qgis_default_value(),
  Fmax = qgisprocess:::qgis_default_value(),
  Jmin = qgisprocess:::qgis_default_value(),
  Jmax = qgisprocess:::qgis_default_value(),
  fCmin = qgisprocess:::qgis_default_value(),
  fCmax = qgisprocess:::qgis_default_value(),
  fDmin = qgisprocess:::qgis_default_value(),
  fDmax = qgisprocess:::qgis_default_value(),
  fEmin = qgisprocess:::qgis_default_value(),
  fEmax = qgisprocess:::qgis_default_value(),
  fFmin = qgisprocess:::qgis_default_value(),
  fFmax = qgisprocess:::qgis_default_value(),
  fJmin = qgisprocess:::qgis_default_value(),
  fJmax = qgisprocess:::qgis_default_value(),
  fK = qgisprocess:::qgis_default_value(),
  G = qgisprocess:::qgis_default_value(),
  H = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

A	raster - Slope grid (rad). Path to a raster layer.
B	raster - Catchment area grid (m2). Path to a raster layer.
Cmin	raster - Min Density grid (g/cm3). Path to a raster layer.
Cmax	raster - Max Density grid (g/cm3). Path to a raster layer.
Dmin	raster - Min Hydraulic conductivity grid (m/hr) . Path to a raster layer.
Dmax	raster - Max Hydraulic conductivity grid (m/hr) . Path to a raster layer.
Emin	raster - Min Thickness grid (m). Path to a raster layer.
Emax	raster - Max Thickness grid (m). Path to a raster layer.
Fmin	raster - Min Friction angle grid (degree) . Path to a raster layer.
Fmax	raster - Max Friction angle grid (degree) . Path to a raster layer.
Jmin	raster - Min Bulk cohesion grid (MPa) . Path to a raster layer.
Jmax	raster - Max Bulk cohesion grid (MPa) . Path to a raster layer.
fCmin	number - Global minimum density (g/cm3). 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.
fCmax	number - Global maximum density (g/cm3). 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.
fDmin	number - Global minimum conductivity (m/hr). 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.
fDmax	number - Global maximum conductivity (m/hr). 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.
fEmin	number - Global minimum thickness (m). 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.
fEmax	number - Global maximum thickness (m). 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.
fFmin	number - Global minimum friction angle (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.
fFmax	number - Global maximum friction angle (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.
fJmin	number - Global minimum bulk cohesion (MPa). 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.
fJmax	number - Global maximum bulk cohesion (MPa). 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.
fK	number - Parameter sampling runs. 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.
G	rasterDestination - CR values. Path for new raster layer.
H	rasterDestination - CR classes. 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

• G - outputRaster - CR values

• H - outputRaster - CR classes

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