sagang_metricconversions: QGIS algorithm - Metric conversions

View source: R/sagang_metricconversions.R

sagang_metricconversionsR Documentation

QGIS algorithm - Metric conversions

Description

QGIS Algorithm provided by SAGA Next Gen Metric conversions (sagang:metricconversions). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer CONV: Converted Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer CONVERSION: Conversion Default value: 0 Argument type: enum Available values: - 0: (0) radians to degree - 1: (1) degree to radians - 2: (2) Celsius to Fahrenheit - 3: (3) Fahrenheit to Celsius Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_metricconversions(
  GRID = qgisprocess:::qgis_default_value(),
  CONV = qgisprocess:::qgis_default_value(),
  CONVERSION = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

CONV

rasterDestination - Converted Grid. Path for new raster layer.

CONVERSION

enum of ⁠("(0) radians to degree", "(1) degree to radians", "(2) Celsius to Fahrenheit", "(3) Fahrenheit to Celsius")⁠ - Conversion. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

...

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

  • CONV - outputRaster - Converted Grid


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