sagang_changedatastorage: QGIS algorithm - Change data storage

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

QGIS algorithm - Change data storage

Description

QGIS Algorithm provided by SAGA Next Gen Change data storage (sagang:changedatastorage). —————- Arguments —————- INPUT: Grid Argument type: raster Acceptable values: - Path to a raster layer OUTPUT: Converted Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer TYPE: Data storage type Default value: 7 Argument type: enum Available values: - 0: (0) bit - 1: (1) unsigned 1 byte integer - 2: (2) signed 1 byte integer - 3: (3) unsigned 2 byte integer - 4: (4) signed 2 byte integer - 5: (5) unsigned 4 byte integer - 6: (6) signed 4 byte integer - 7: (7) 4 byte floating point number - 8: (8) 8 byte floating point number Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' OFFSET: Offset Default value: 0 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 SCALE: Scale Default value: 1 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

Usage

sagang_changedatastorage(
  INPUT = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  TYPE = qgisprocess:::qgis_default_value(),
  OFFSET = qgisprocess:::qgis_default_value(),
  SCALE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	raster - Grid. Path to a raster layer.
OUTPUT	rasterDestination - Converted Grid. Path for new raster layer.
TYPE	enum of ⁠("(0) bit", "(1) unsigned 1 byte integer", "(2) signed 1 byte integer", "(3) unsigned 2 byte integer", "(4) signed 2 byte integer", "(5) unsigned 4 byte integer", "(6) signed 4 byte integer", "(7) 4 byte floating point number", "(8) 8 byte floating point number")⁠ - Data storage type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
OFFSET	number - Offset. 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.
SCALE	number - Scale. 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.
...	further parameters passed to qgisprocess::qgis_run_algorithm()
.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.
.quiet	logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.
.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 - outputRaster - Converted Grid

JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.