sagang_landusescenariogenerator: QGIS algorithm - Land use scenario generator

View source: R/sagang_landusescenariogenerator.R

sagang_landusescenariogeneratorR Documentation

QGIS algorithm - Land use scenario generator

Description

QGIS Algorithm provided by SAGA Next Gen Land use scenario generator (sagang:landusescenariogenerator). —————- Arguments —————- FIELDS: Fields Argument type: source Acceptable values: - Path to a vector layer FIELD_ID: Field Identifier Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names SCENARIO: Land Use Scenario Argument type: vectorDestination Acceptable values: - Path for new vector layer OUTPUT: Output of... Default value: 0 Argument type: enum Available values: - 0: (0) Identifier - 1: (1) Name Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' STATISTICS: Crop Statistics Argument type: source Acceptable values: - Path to a vector layer KNOWN_CROPS: Known Crops (optional) Argument type: source Acceptable values: - Path to a vector layer

Usage

sagang_landusescenariogenerator(
  FIELDS = qgisprocess:::qgis_default_value(),
  FIELD_ID = qgisprocess:::qgis_default_value(),
  SCENARIO = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  STATISTICS = qgisprocess:::qgis_default_value(),
  KNOWN_CROPS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

FIELDS

source - Fields. Path to a vector layer.

FIELD_ID

field - Field Identifier. The name of an existing field. ; delimited list of existing field names.

SCENARIO

vectorDestination - Land Use Scenario. Path for new vector layer.

OUTPUT

enum of ⁠("(0) Identifier", "(1) Name")⁠ - Output of.... Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

STATISTICS

source - Crop Statistics. Path to a vector layer.

KNOWN_CROPS

source - Known Crops. Path to a vector 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

  • SCENARIO - outputVector - Land Use Scenario


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