sagang_rasterbuffer: QGIS algorithm - Raster buffer

View source: R/sagang_rasterbuffer.R

sagang_rasterbufferR Documentation

QGIS algorithm - Raster buffer

Description

QGIS Algorithm provided by SAGA Next Gen Raster buffer (sagang:rasterbuffer). —————- Arguments —————- FEATURES: Features Argument type: raster Acceptable values: - Path to a raster layer BUFFER: Buffer Argument type: rasterDestination Acceptable values: - Path for new raster layer TYPE: Type Default value: 0 Argument type: enum Available values: - 0: (0) fixed - 1: (1) cell's value Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' DISTANCE: Distance Default value: 1000 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_rasterbuffer(
  FEATURES = qgisprocess:::qgis_default_value(),
  BUFFER = qgisprocess:::qgis_default_value(),
  TYPE = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

FEATURES

raster - Features. Path to a raster layer.

BUFFER

rasterDestination - Buffer. Path for new raster layer.

TYPE

enum of ⁠("(0) fixed", "(1) cell's value")⁠ - Type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

DISTANCE

number - Distance. 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

  • BUFFER - outputRaster - Buffer


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