R/sagang_channelnetworkanddrainagebasins.R

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

##' QGIS Algorithm provided by SAGA Next Gen Channel network and drainage basins (sagang:channelnetworkanddrainagebasins). ---------------- Arguments ----------------  DEM: Elevation 	Argument type:	raster 	Acceptable values: 		- Path to a raster layer DIRECTION: Flow Direction 	Argument type:	rasterDestination 	Acceptable values: 		- Path for new raster layer CONNECTION: Flow Connectivity 	Argument type:	rasterDestination 	Acceptable values: 		- Path for new raster layer ORDER: Strahler Order 	Argument type:	rasterDestination 	Acceptable values: 		- Path for new raster layer BASIN: Drainage Basins 	Argument type:	rasterDestination 	Acceptable values: 		- Path for new raster layer SEGMENTS: Channels 	Argument type:	vectorDestination 	Acceptable values: 		- Path for new vector layer BASINS: Drainage Basins 	Argument type:	vectorDestination 	Acceptable values: 		- Path for new vector layer NODES: Junctions 	Argument type:	vectorDestination 	Acceptable values: 		- Path for new vector layer THRESHOLD: Threshold 	Default value:	5 	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 - Channel network and drainage basins
##'
##' @param DEM `raster` - Elevation. Path to a raster layer.
##' @param DIRECTION `rasterDestination` - Flow Direction. Path for new raster layer.
##' @param CONNECTION `rasterDestination` - Flow Connectivity. Path for new raster layer.
##' @param ORDER `rasterDestination` - Strahler Order. Path for new raster layer.
##' @param BASIN `rasterDestination` - Drainage Basins. Path for new raster layer.
##' @param SEGMENTS `vectorDestination` - Channels. Path for new vector layer.
##' @param BASINS `vectorDestination` - Drainage Basins. Path for new vector layer.
##' @param NODES `vectorDestination` - Junctions. Path for new vector layer.
##' @param THRESHOLD `number` - Threshold. 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
##' * BASIN - outputRaster - Drainage Basins
##' * BASINS - outputVector - Drainage Basins
##' * CONNECTION - outputRaster - Flow Connectivity
##' * DIRECTION - outputRaster - Flow Direction
##' * NODES - outputVector - Junctions
##' * ORDER - outputRaster - Strahler Order
##' * SEGMENTS - outputVector - Channels
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

sagang_channelnetworkanddrainagebasins <- function(DEM = qgisprocess:::qgis_default_value(), DIRECTION = qgisprocess:::qgis_default_value(), CONNECTION = qgisprocess:::qgis_default_value(), ORDER = qgisprocess:::qgis_default_value(), BASIN = qgisprocess:::qgis_default_value(), SEGMENTS = qgisprocess:::qgis_default_value(), BASINS = qgisprocess:::qgis_default_value(), NODES = qgisprocess:::qgis_default_value(), THRESHOLD = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {

  check_algorithm_necessities("sagang:channelnetworkanddrainagebasins")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("sagang:channelnetworkanddrainagebasins", `DEM` = DEM, `DIRECTION` = DIRECTION, `CONNECTION` = CONNECTION, `ORDER` = ORDER, `BASIN` = BASIN, `SEGMENTS` = SEGMENTS, `BASINS` = BASINS, `NODES` = NODES, `THRESHOLD` = THRESHOLD,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("sagang:channelnetworkanddrainagebasins", `DEM` = DEM, `DIRECTION` = DIRECTION, `CONNECTION` = CONNECTION, `ORDER` = ORDER, `BASIN` = BASIN, `SEGMENTS` = SEGMENTS, `BASINS` = BASINS, `NODES` = NODES, `THRESHOLD` = THRESHOLD,..., .quiet = .quiet)
      )
  }

  if (.complete_output) {
    return(output)
  }
  else{
    qgisprocess::qgis_extract_output(output, "BASIN")
  }
}