qgis_hypsometriccurves: QGIS algorithm - Hypsometric curves

View source: R/qgis_hypsometriccurves.R

qgis_hypsometriccurvesR Documentation

QGIS algorithm - Hypsometric curves

Description

QGIS Algorithm provided by QGIS Hypsometric curves (qgis:hypsometriccurves). This algorithm computes hypsometric curves for an input Digital Elevation Model. Curves are produced as table files in an output folder specified by the user.

Usage

qgis_hypsometriccurves(
  INPUT_DEM = qgisprocess:::qgis_default_value(),
  BOUNDARY_LAYER = qgisprocess:::qgis_default_value(),
  STEP = qgisprocess:::qgis_default_value(),
  USE_PERCENTAGE = qgisprocess:::qgis_default_value(),
  OUTPUT_DIRECTORY = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT_DEM

raster - DEM to analyze. Path to a raster layer.

BOUNDARY_LAYER

source - Boundary layer. Path to a vector layer.

STEP

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

USE_PERCENTAGE

boolean - Use % of area instead of absolute value. 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.

OUTPUT_DIRECTORY

folderDestination - Hypsometric curves. Path for an existing or new folder.

...

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

  • OUTPUT_DIRECTORY - outputFolder - Hypsometric curves


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