sagang_kmeansclusteringforgrids: QGIS algorithm - K-means clustering for grids

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

QGIS algorithm - K-means clustering for grids

Description

QGIS Algorithm provided by SAGA Next Gen K-means clustering for grids (sagang:kmeansclusteringforgrids). —————- Arguments —————- GRIDS: Grids Argument type: multilayer CLUSTER: Clusters Argument type: rasterDestination Acceptable values: - Path for new raster layer STATISTICS: Statistics Argument type: vectorDestination Acceptable values: - Path for new vector layer METHOD: Method Default value: 1 Argument type: enum Available values: - 0: (0) Iterative Minimum Distance (Forgy 1965) - 1: (1) Hill-Climbing (Rubin 1967) - 2: (2) Combined Minimum Distance / Hillclimbing Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' NCLUSTER: Clusters Default value: 10 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 MAXITER: Maximum Iterations Default value: 10 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 NORMALISE: Normalise Default value: false Argument type: boolean Acceptable values: - 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 INITIALIZE: Start Partition Default value: 0 Argument type: enum Available values: - 0: (0) random - 1: (1) periodical - 2: (2) keep values Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' OLDVERSION: Old Version Default value: false Argument type: boolean Acceptable values: - 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 UPDATEVIEW: Update View Default value: true Argument type: boolean Acceptable values: - 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

Usage

sagang_kmeansclusteringforgrids(
  GRIDS = qgisprocess:::qgis_default_value(),
  CLUSTER = qgisprocess:::qgis_default_value(),
  STATISTICS = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  NCLUSTER = qgisprocess:::qgis_default_value(),
  MAXITER = qgisprocess:::qgis_default_value(),
  NORMALISE = qgisprocess:::qgis_default_value(),
  INITIALIZE = qgisprocess:::qgis_default_value(),
  OLDVERSION = qgisprocess:::qgis_default_value(),
  UPDATEVIEW = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRIDS	multilayer - Grids. .
CLUSTER	rasterDestination - Clusters. Path for new raster layer.
STATISTICS	vectorDestination - Statistics. Path for new vector layer.
METHOD	enum of ⁠("(0) Iterative Minimum Distance (Forgy 1965)", "(1) Hill-Climbing (Rubin 1967)", "(2) Combined Minimum Distance / Hillclimbing")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
NCLUSTER	number - Clusters. 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.
MAXITER	number - Maximum Iterations. 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.
NORMALISE	boolean - Normalise. 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.
INITIALIZE	enum of ⁠("(0) random", "(1) periodical", "(2) keep values")⁠ - Start Partition. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
OLDVERSION	boolean - Old Version. 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.
UPDATEVIEW	boolean - Update View. 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.
...	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

• CLUSTER - outputRaster - Clusters

• STATISTICS - outputVector - Statistics

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