sagang_morphometricprotectionindex: QGIS algorithm - Morphometric protection index

View source: R/sagang_morphometricprotectionindex.R

sagang_morphometricprotectionindexR Documentation

QGIS algorithm - Morphometric protection index

Description

QGIS Algorithm provided by SAGA Next Gen Morphometric protection index (sagang:morphometricprotectionindex). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer PROTECTION: Protection Index Argument type: rasterDestination Acceptable values: - Path for new raster layer RADIUS: Radius Default value: 2000 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_morphometricprotectionindex(
  DEM = qgisprocess:::qgis_default_value(),
  PROTECTION = qgisprocess:::qgis_default_value(),
  RADIUS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM

raster - Elevation. Path to a raster layer.

PROTECTION

rasterDestination - Protection Index. Path for new raster layer.

RADIUS

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

  • PROTECTION - outputRaster - Protection Index


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