##' QGIS Algorithm provided by SAGA Next Gen Sink drainage route detection (sagang:sinkdrainageroutedetection). ---------------- Arguments ---------------- ELEVATION: Elevation Argument type: raster Acceptable values: - Path to a raster layer SINKROUTE: Sink Route Argument type: rasterDestination Acceptable values: - Path for new raster layer THRESHOLD: Threshold 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 THRSHEIGHT: Threshold Height Default value: 100 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
##'
##' @title QGIS algorithm - Sink drainage route detection
##'
##' @param ELEVATION `raster` - Elevation. Path to a raster layer.
##' @param SINKROUTE `rasterDestination` - Sink Route. Path for new raster layer.
##' @param THRESHOLD `boolean` - Threshold. 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.
##' @param THRSHEIGHT `number` - Threshold Height. 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.
##' @param ... further parameters passed to `qgisprocess::qgis_run_algorithm()`
##' @param .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`.
##' @param .quiet logical specifying if parameter `.quiet` for `qgisprocess::qgis_run_algorithm()` Default value is `TRUE`.
##' @param .messages logical specifying if messages from `qgisprocess::qgis_run_algorithm()` should be printed (`TRUE`) or not (`FALSE`). Default value is `FALSE`.
##'
##' @details
##' ## Outputs description
##' * SINKROUTE - outputRaster - Sink Route
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm
sagang_sinkdrainageroutedetection <- function(ELEVATION = qgisprocess:::qgis_default_value(), SINKROUTE = qgisprocess:::qgis_default_value(), THRESHOLD = qgisprocess:::qgis_default_value(), THRSHEIGHT = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {
check_algorithm_necessities("sagang:sinkdrainageroutedetection")
if (.messages){
output <- qgisprocess::qgis_run_algorithm("sagang:sinkdrainageroutedetection", `ELEVATION` = ELEVATION, `SINKROUTE` = SINKROUTE, `THRESHOLD` = THRESHOLD, `THRSHEIGHT` = THRSHEIGHT,..., .quiet = .quiet)
} else {
suppressMessages(
output <- qgisprocess::qgis_run_algorithm("sagang:sinkdrainageroutedetection", `ELEVATION` = ELEVATION, `SINKROUTE` = SINKROUTE, `THRESHOLD` = THRESHOLD, `THRSHEIGHT` = THRSHEIGHT,..., .quiet = .quiet)
)
}
if (.complete_output) {
return(output)
}
else{
qgisprocess::qgis_extract_output(output, "SINKROUTE")
}
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.