sagang_geometricfigures: QGIS algorithm - Geometric figures

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

QGIS algorithm - Geometric figures

Description

QGIS Algorithm provided by SAGA Next Gen Geometric figures (sagang:geometricfigures). —————- Arguments —————- RESULT: Result Argument type: rasterDestination Acceptable values: - Path for new raster layer CELL_COUNT: Cell Count 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 CELL_SIZE: Cell Size Default value: 1 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 FIGURE: Figure Default value: 0 Argument type: enum Available values: - 0: (0) Cone (up) - 1: (1) Cone (down) - 2: (2) Plane Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' PLANE: Direction of Plane (Degree) Default value: 22.5 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_geometricfigures(
  RESULT = qgisprocess:::qgis_default_value(),
  CELL_COUNT = qgisprocess:::qgis_default_value(),
  CELL_SIZE = qgisprocess:::qgis_default_value(),
  FIGURE = qgisprocess:::qgis_default_value(),
  PLANE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

RESULT	rasterDestination - Result. Path for new raster layer.
CELL_COUNT	number - Cell Count. 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.
CELL_SIZE	number - Cell Size. 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.
FIGURE	enum of ⁠("(0) Cone (up)", "(1) Cone (down)", "(2) Plane")⁠ - Figure. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
PLANE	number - Direction of Plane (Degree). 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

• RESULT - outputRaster - Result

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