sagang_hypsometry: QGIS algorithm - Hypsometry

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - Hypsometry

Description

QGIS Algorithm provided by SAGA Next Gen Hypsometry (sagang:hypsometry). —————- Arguments —————- ELEVATION: Elevation Argument type: raster Acceptable values: - Path to a raster layer TABLE: Hypsometry Argument type: vectorDestination Acceptable values: - Path for new vector layer COUNT: Number of Classes Default value: 100 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 SORTING: Sort Default value: 1 Argument type: enum Available values: - 0: (0) up - 1: (1) down Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' METHOD: Classification Constant Default value: 1 Argument type: enum Available values: - 0: (0) height - 1: (1) area Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' BZRANGE: Use Z-Range Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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_hypsometry(
  ELEVATION = qgisprocess:::qgis_default_value(),
  TABLE = qgisprocess:::qgis_default_value(),
  COUNT = qgisprocess:::qgis_default_value(),
  SORTING = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  BZRANGE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ELEVATION	raster - Elevation. Path to a raster layer.
TABLE	vectorDestination - Hypsometry. Path for new vector layer.
COUNT	number - 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.
SORTING	enum of ⁠("(0) up", "(1) down")⁠ - Sort. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
METHOD	enum of ⁠("(0) height", "(1) area")⁠ - Classification Constant. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
BZRANGE	boolean - Use Z-Range. 1 for true/yes. 0 for false/no. 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

• TABLE - outputVector - Hypsometry

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