sagang_rivergridgeneration: QGIS algorithm - Rivergridgeneration

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

QGIS algorithm - Rivergridgeneration

Description

QGIS Algorithm provided by SAGA Next Gen Rivergridgeneration (sagang:rivergridgeneration). —————- Arguments —————- INPUT: Gel_ndemodell (DTM) Argument type: raster Acceptable values: - Path to a raster layer OUTPUT: HG Raster Argument type: rasterDestination Acceptable values: - Path for new raster layer SX: Abflusspfad-Quelle, x-Wert 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 SY: Abflusspfad-Quelle, y-Wert 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 MX: Abflusspfad-M_ndung, x-Wert 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 MY: Abflusspfad-M_ndung, y-Wert 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 Owrite: Overwrite RiverGridCells Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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_rivergridgeneration(
  INPUT = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  SX = qgisprocess:::qgis_default_value(),
  SY = qgisprocess:::qgis_default_value(),
  MX = qgisprocess:::qgis_default_value(),
  MY = qgisprocess:::qgis_default_value(),
  Owrite = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	raster - Gel_ndemodell (DTM). Path to a raster layer.
OUTPUT	rasterDestination - HG Raster. Path for new raster layer.
SX	number - Abflusspfad-Quelle, x-Wert. 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.
SY	number - Abflusspfad-Quelle, y-Wert. 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.
MX	number - Abflusspfad-M_ndung, x-Wert. 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.
MY	number - Abflusspfad-M_ndung, y-Wert. 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.
Owrite	boolean - Overwrite RiverGridCells. 1 for true/yes. 0 for false/no. 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

• OUTPUT - outputRaster - HG Raster

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