sagang_polynomialregression: QGIS algorithm - Polynomial regression

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

QGIS algorithm - Polynomial regression

Description

QGIS Algorithm provided by SAGA Next Gen Polynomial regression (sagang:polynomialregression). —————- Arguments —————- POINTS: Points Argument type: source Acceptable values: - Path to a vector layer ATTRIBUTE: Attribute Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names RESIDUALS: Residuals Argument type: vectorDestination Acceptable values: - Path for new vector layer POLYNOM: Polynom Default value: 0 Argument type: enum Available values: - 0: (0) simple planar surface - 1: (1) bi-linear saddle - 2: (2) quadratic surface - 3: (3) cubic surface - 4: (4) user defined Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' XORDER: Maximum X Order Default value: 4 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 YORDER: Maximum Y Order Default value: 4 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 TORDER: Maximum Total Order Default value: 4 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 TARGET_USER_XMIN TARGET_USER_XMAX TARGET_USER_YMIN TARGET_USER_YMAX: Output extent (optional) Argument type: extent Acceptable values: - A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105' - Path to a layer. The extent of the layer is used. TARGET_USER_SIZE: Cellsize 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 TARGET_OUT_GRID: Target Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

sagang_polynomialregression(
  POINTS = qgisprocess:::qgis_default_value(),
  ATTRIBUTE = qgisprocess:::qgis_default_value(),
  RESIDUALS = qgisprocess:::qgis_default_value(),
  POLYNOM = qgisprocess:::qgis_default_value(),
  XORDER = qgisprocess:::qgis_default_value(),
  YORDER = qgisprocess:::qgis_default_value(),
  TORDER = qgisprocess:::qgis_default_value(),
  TARGET_USER_XMIN_TARGET_USER_XMAX_TARGET_USER_YMIN_TARGET_USER_YMAX =
    qgisprocess:::qgis_default_value(),
  TARGET_USER_SIZE = qgisprocess:::qgis_default_value(),
  TARGET_OUT_GRID = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POINTS	source - Points. Path to a vector layer.
ATTRIBUTE	field - Attribute. The name of an existing field. ; delimited list of existing field names.
RESIDUALS	vectorDestination - Residuals. Path for new vector layer.
POLYNOM	enum of ⁠("(0) simple planar surface", "(1) bi-linear saddle", "(2) quadratic surface", "(3) cubic surface", "(4) user defined")⁠ - Polynom. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
XORDER	number - Maximum X Order. 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.
YORDER	number - Maximum Y Order. 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.
TORDER	number - Maximum Total Order. 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.
TARGET_USER_XMIN_TARGET_USER_XMAX_TARGET_USER_YMIN_TARGET_USER_YMAX	extent - Output extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used.. Original algorithm parameter name: TARGET_USER_XMIN TARGET_USER_XMAX TARGET_USER_YMIN TARGET_USER_YMAX.
TARGET_USER_SIZE	number - Cellsize. 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.
TARGET_OUT_GRID	rasterDestination - Target Grid. Path for new raster 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

• RESIDUALS - outputVector - Residuals

• TARGET_OUT_GRID - outputRaster - Target Grid

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