R/sagang_crossclassificationandtabulation.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 Cross-classification and tabulation (sagang:crossclassificationandtabulation). ---------------- Arguments ----------------  INPUT: Input Grid 1 	Argument type:	raster 	Acceptable values: 		- Path to a raster layer INPUT2: Input Grid 2 	Argument type:	raster 	Acceptable values: 		- Path to a raster layer RESULTGRID: Cross-Classification Grid 	Argument type:	rasterDestination 	Acceptable values: 		- Path for new raster layer RESULTTABLE: Cross-Tabulation Table 	Argument type:	vectorDestination 	Acceptable values: 		- Path for new vector layer MAXNUMCLASS: Max. Number of Classes 	Default value:	10 	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 - Cross-classification and tabulation
##'
##' @param INPUT `raster` - Input Grid 1. Path to a raster layer.
##' @param INPUT2 `raster` - Input Grid 2. Path to a raster layer.
##' @param RESULTGRID `rasterDestination` - Cross-Classification Grid. Path for new raster layer.
##' @param RESULTTABLE `vectorDestination` - Cross-Tabulation Table. Path for new vector layer.
##' @param MAXNUMCLASS `number` - Max. Number of Classes. 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
##' * RESULTGRID - outputRaster - Cross-Classification Grid
##' * RESULTTABLE - outputVector - Cross-Tabulation Table
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

sagang_crossclassificationandtabulation <- function(INPUT = qgisprocess:::qgis_default_value(), INPUT2 = qgisprocess:::qgis_default_value(), RESULTGRID = qgisprocess:::qgis_default_value(), RESULTTABLE = qgisprocess:::qgis_default_value(), MAXNUMCLASS = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {

  check_algorithm_necessities("sagang:crossclassificationandtabulation")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("sagang:crossclassificationandtabulation", `INPUT` = INPUT, `INPUT2` = INPUT2, `RESULTGRID` = RESULTGRID, `RESULTTABLE` = RESULTTABLE, `MAXNUMCLASS` = MAXNUMCLASS,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("sagang:crossclassificationandtabulation", `INPUT` = INPUT, `INPUT2` = INPUT2, `RESULTGRID` = RESULTGRID, `RESULTTABLE` = RESULTTABLE, `MAXNUMCLASS` = MAXNUMCLASS,..., .quiet = .quiet)
      )
  }

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