sagang_regressionanalysispointsandpredictorgrid: QGIS algorithm - Regression analysis (points and predictor...

View source: R/sagang_regressionanalysispointsandpredictorgrid.R

sagang_regressionanalysispointsandpredictorgridR Documentation

QGIS algorithm - Regression analysis (points and predictor grid)

Description

QGIS Algorithm provided by SAGA Next Gen Regression analysis (points and predictor grid) (sagang:regressionanalysispointsandpredictorgrid). —————- Arguments —————- PREDICTOR: Predictor Argument type: raster Acceptable values: - Path to a raster layer POINTS: Points Argument type: source Acceptable values: - Path to a vector layer ATTRIBUTE: Dependent Variable Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names REGRESSION: Regression Argument type: rasterDestination Acceptable values: - Path for new raster layer RESIDUAL: Residuals Argument type: vectorDestination Acceptable values: - Path for new vector layer RESAMPLING: Resampling Default value: 3 Argument type: enum Available values: - 0: (0) Nearest Neighbour - 1: (1) Bilinear Interpolation - 2: (2) Bicubic Spline Interpolation - 3: (3) B-Spline Interpolation Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' METHOD: Regression Function Default value: 0 Argument type: enum Available values: - 0: (0) Y = a + b * X (linear) - 1: (1) Y = a + b / X - 2: (2) Y = a / (b - X) - 3: (3) Y = a * X^b (power) - 4: (4) Y = a e^(b * X) (exponential) - 5: (5) Y = a + b * ln(X) (logarithmic) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_regressionanalysispointsandpredictorgrid(
  PREDICTOR = qgisprocess:::qgis_default_value(),
  POINTS = qgisprocess:::qgis_default_value(),
  ATTRIBUTE = qgisprocess:::qgis_default_value(),
  REGRESSION = qgisprocess:::qgis_default_value(),
  RESIDUAL = qgisprocess:::qgis_default_value(),
  RESAMPLING = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

PREDICTOR

raster - Predictor. Path to a raster layer.

POINTS

source - Points. Path to a vector layer.

ATTRIBUTE

field - Dependent Variable. The name of an existing field. ; delimited list of existing field names.

REGRESSION

rasterDestination - Regression. Path for new raster layer.

RESIDUAL

vectorDestination - Residuals. Path for new vector layer.

RESAMPLING

enum of ⁠("(0) Nearest Neighbour", "(1) Bilinear Interpolation", "(2) Bicubic Spline Interpolation", "(3) B-Spline Interpolation")⁠ - Resampling. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

METHOD

enum of ⁠("(0) Y = a + b * X (linear)", "(1) Y = a + b / X", "(2) Y = a / (b - X)", "(3) Y = a * X^b (power)", "(4) Y = a e^(b * X) (exponential)", "(5) Y = a + b * ln(X) (logarithmic)")⁠ - Regression Function. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

...

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

  • REGRESSION - outputRaster - Regression

  • RESIDUAL - outputVector - Residuals


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