grass_v_class: QGIS algorithm - v.class

View source: R/grass_v_class.R

grass_v_classR Documentation

QGIS algorithm - v.class

Description

QGIS Algorithm provided by GRASS v.class (grass:v.class). Classifies attribute data, e.g. for thematic mapping.

Usage

grass_v_class(
  map = qgisprocess:::qgis_default_value(),
  column = qgisprocess:::qgis_default_value(),
  where = qgisprocess:::qgis_default_value(),
  algorithm = qgisprocess:::qgis_default_value(),
  nbclasses = qgisprocess:::qgis_default_value(),
  .g = qgisprocess:::qgis_default_value(),
  html = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_SNAP_TOLERANCE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_MIN_AREA_PARAMETER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

map

source - Input vector layer. Path to a vector layer.

column

field - Column name or expression. The name of an existing field. ; delimited list of existing field names.

where

string - WHERE conditions of SQL statement without 'where' keyword. String 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.

algorithm

enum of ⁠("int", "std", "qua", "equ")⁠ - Algorithm to use for classification. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

nbclasses

number - Number of classes to define. 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.

.g

boolean - Print only class breaks (without min and max). 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. Original algorithm parameter name: -g.

html

fileDestination - Classification. Path for new file.

GRASS_REGION_PARAMETER

extent - GRASS GIS region 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..

GRASS_SNAP_TOLERANCE_PARAMETER

number - v.in.ogr snap tolerance (-1 = no snap). 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.

GRASS_MIN_AREA_PARAMETER

number - v.in.ogr min area. 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

  • html - outputHtml - Classification


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