sagang_meltonruggednessnumber: QGIS algorithm - Melton ruggedness number

View source: R/sagang_meltonruggednessnumber.R

sagang_meltonruggednessnumberR Documentation

QGIS algorithm - Melton ruggedness number

Description

QGIS Algorithm provided by SAGA Next Gen Melton ruggedness number (sagang:meltonruggednessnumber). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer AREA: Catchment Area Argument type: rasterDestination Acceptable values: - Path for new raster layer ZMAX: Maximum Height Argument type: rasterDestination Acceptable values: - Path for new raster layer MRN: Melton Ruggedness Number Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

sagang_meltonruggednessnumber(
  DEM = qgisprocess:::qgis_default_value(),
  AREA = qgisprocess:::qgis_default_value(),
  ZMAX = qgisprocess:::qgis_default_value(),
  MRN = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM

raster - Elevation. Path to a raster layer.

AREA

rasterDestination - Catchment Area. Path for new raster layer.

ZMAX

rasterDestination - Maximum Height. Path for new raster layer.

MRN

rasterDestination - Melton Ruggedness Number. 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

  • AREA - outputRaster - Catchment Area

  • MRN - outputRaster - Melton Ruggedness Number

  • ZMAX - outputRaster - Maximum Height


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