sagang_rastervolume: QGIS algorithm - Raster volume

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

QGIS algorithm - Raster volume

Description

QGIS Algorithm provided by SAGA Next Gen Raster volume (sagang:rastervolume). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer METHOD: Method Default value: 0 Argument type: enum Available values: - 0: (0) Count Only Above Base Level - 1: (1) Count Only Below Base Level - 2: (2) Subtract Volumes Below Base Level - 3: (3) Add Volumes Below Base Level Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' LEVEL: Base Level Default value: 0 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_rastervolume(
  GRID = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  LEVEL = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID	raster - Grid. Path to a raster layer.
METHOD	enum of ⁠("(0) Count Only Above Base Level", "(1) Count Only Below Base Level", "(2) Subtract Volumes Below Base Level", "(3) Add Volumes Below Base Level")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
LEVEL	number - Base Level. 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

No output description provided.

JanCaha/r_package_qgis documentation built on May 1, 2024, 3:30 a.m.