R/sagang_tcilow.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 Tci low (sagang:tcilow). ---------------- Arguments ----------------  DISTANCE: Vertical Distance to Channel Network 	Argument type:	raster 	Acceptable values: 		- Path to a raster layer TWI: Topographic Wetness Index 	Argument type:	raster 	Acceptable values: 		- Path to a raster layer TCILOW: TCI Low 	Argument type:	rasterDestination 	Acceptable values: 		- Path for new raster layer
##'
##' @title QGIS algorithm - Tci low
##'
##' @param DISTANCE `raster` - Vertical Distance to Channel Network. Path to a raster layer.
##' @param TWI `raster` - Topographic Wetness Index. Path to a raster layer.
##' @param TCILOW `rasterDestination` - TCI Low. Path for new raster layer.
##' @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
##' * TCILOW - outputRaster - TCI Low
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

sagang_tcilow <- function(DISTANCE = qgisprocess:::qgis_default_value(), TWI = qgisprocess:::qgis_default_value(), TCILOW = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {

  check_algorithm_necessities("sagang:tcilow")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("sagang:tcilow", `DISTANCE` = DISTANCE, `TWI` = TWI, `TCILOW` = TCILOW,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("sagang:tcilow", `DISTANCE` = DISTANCE, `TWI` = TWI, `TCILOW` = TCILOW,..., .quiet = .quiet)
      )
  }

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