R/sagang_breachdepressions.R
sagang_breachdepressions.Rd
QGIS Algorithm provided by SAGA Next Gen Breach depressions (sagang:breachdepressions). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer NOSINKS: Preprocessed Argument type: rasterDestination Acceptable values: - Path for new raster layer MAX_LENGTH: Maximum Breach Channel Length Default value: 50 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 MAX_ZDEC: Maximum Elevation Decrement 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 MIN_ZDROP: Minimum Elevation Drop 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
sagang_breachdepressions(
DEM = qgisprocess:::qgis_default_value(),
NOSINKS = qgisprocess:::qgis_default_value(),
MAX_LENGTH = qgisprocess:::qgis_default_value(),
MAX_ZDEC = qgisprocess:::qgis_default_value(),
MIN_ZDROP = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
raster
- Elevation. Path to a raster layer.
rasterDestination
- Preprocessed. Path for new raster layer.
number
- Maximum Breach Channel Length. 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.
number
- Maximum Elevation Decrement. 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.
number
- Minimum Elevation Drop. 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()
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
.
logical specifying if parameter .quiet
for qgisprocess::qgis_run_algorithm()
Default value is TRUE
.
logical specifying if messages from qgisprocess::qgis_run_algorithm()
should be printed (TRUE
) or not (FALSE
). Default value is FALSE
.