sagang_proximityraster: QGIS algorithm - Proximity raster

View source: R/sagang_proximityraster.R

sagang_proximityrasterR Documentation

QGIS algorithm - Proximity raster

Description

QGIS Algorithm provided by SAGA Next Gen Proximity raster (sagang:proximityraster). —————- Arguments —————- FEATURES: Features Argument type: raster Acceptable values: - Path to a raster layer DISTANCE: Distance Argument type: rasterDestination Acceptable values: - Path for new raster layer DIRECTION: Direction Argument type: rasterDestination Acceptable values: - Path for new raster layer ALLOCATION: Allocation Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

sagang_proximityraster(
  FEATURES = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  DIRECTION = qgisprocess:::qgis_default_value(),
  ALLOCATION = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

FEATURES

raster - Features. Path to a raster layer.

DISTANCE

rasterDestination - Distance. Path for new raster layer.

DIRECTION

rasterDestination - Direction. Path for new raster layer.

ALLOCATION

rasterDestination - Allocation. Path for new raster layer.

...

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

  • ALLOCATION - outputRaster - Allocation

  • DIRECTION - outputRaster - Direction

  • DISTANCE - outputRaster - Distance


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