sagang_rastercellindex: QGIS algorithm - Raster cell index

View source: R/sagang_rastercellindex.R

sagang_rastercellindexR Documentation

QGIS algorithm - Raster cell index

Description

QGIS Algorithm provided by SAGA Next Gen Raster cell index (sagang:rastercellindex). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer INDEX: Index Argument type: rasterDestination Acceptable values: - Path for new raster layer ORDER: Sorting Order Default value: 0 Argument type: enum Available values: - 0: (0) ascending - 1: (1) descending Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_rastercellindex(
  GRID = qgisprocess:::qgis_default_value(),
  INDEX = qgisprocess:::qgis_default_value(),
  ORDER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

INDEX

rasterDestination - Index. Path for new raster layer.

ORDER

enum of ⁠("(0) ascending", "(1) descending")⁠ - Sorting Order. 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

  • INDEX - outputRaster - Index


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