R/qgis_exporttospreadsheet.R

Defines functions qgis_exporttospreadsheet

Documented in qgis_exporttospreadsheet

##' QGIS Algorithm provided by QGIS (native c++) Export to spreadsheet (native:exporttospreadsheet). This algorithm collects a number of existing layers and exports them into a spreadsheet document.  Optionally the layers can be appended to an existing spreadsheet as additional sheets.
##'
##' @title QGIS algorithm - Export to spreadsheet
##'
##' @param LAYERS `multilayer` - Input layers. .
##' @param USE_ALIAS `boolean` - Use field aliases as column headings. 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 FORMATTED_VALUES `boolean` - Export formatted values instead of raw 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.
##' @param OUTPUT `fileDestination` - Destination spreadsheet. Path for new file.
##' @param OVERWRITE `boolean` - Overwrite existing spreadsheet. 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 ... 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
##' * OUTPUT - outputFile - Destination spreadsheet
##' * OUTPUT_LAYERS - outputMultilayer - Layers within spreadsheet
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

qgis_exporttospreadsheet <- function(LAYERS = qgisprocess:::qgis_default_value(), USE_ALIAS = qgisprocess:::qgis_default_value(), FORMATTED_VALUES = qgisprocess:::qgis_default_value(), OUTPUT = qgisprocess:::qgis_default_value(), OVERWRITE = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {

  check_algorithm_necessities("native:exporttospreadsheet")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("native:exporttospreadsheet", `LAYERS` = LAYERS, `USE_ALIAS` = USE_ALIAS, `FORMATTED_VALUES` = FORMATTED_VALUES, `OUTPUT` = OUTPUT, `OVERWRITE` = OVERWRITE,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("native:exporttospreadsheet", `LAYERS` = LAYERS, `USE_ALIAS` = USE_ALIAS, `FORMATTED_VALUES` = FORMATTED_VALUES, `OUTPUT` = OUTPUT, `OVERWRITE` = OVERWRITE,..., .quiet = .quiet)
      )
  }

  if (.complete_output) {
    return(output)
  }
  else{
    qgisprocess::qgis_extract_output(output, "OUTPUT")
  }
}
JanCaha/r_package_qgis documentation built on March 5, 2024, 3:12 p.m.