sagang_aggregationindex: QGIS algorithm - Aggregation index

View source: R/sagang_aggregationindex.R

sagang_aggregationindexR Documentation

QGIS algorithm - Aggregation index

Description

QGIS Algorithm provided by SAGA Next Gen Aggregation index (sagang:aggregationindex). —————- Arguments —————- INPUT: Input Grid Argument type: raster Acceptable values: - Path to a raster layer MAXNUMCLASS: Max. Number of Classes Default value: 10 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 RESULT: Result Argument type: vectorDestination Acceptable values: - Path for new vector layer

Usage

sagang_aggregationindex(
  INPUT = qgisprocess:::qgis_default_value(),
  MAXNUMCLASS = qgisprocess:::qgis_default_value(),
  RESULT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Input Grid. Path to a raster layer.

MAXNUMCLASS

number - Max. Number of Classes. 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.

RESULT

vectorDestination - Result. Path for new vector 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

  • RESULT - outputVector - Result


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