qgis_addautoincrementalfield: QGIS algorithm - Add autoincremental field

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

QGIS algorithm - Add autoincremental field

Description

QGIS Algorithm provided by QGIS (native c++) Add autoincremental field (native:addautoincrementalfield). This algorithm adds a new integer field to a vector layer, with a sequential value for each feature. This field can be used as a unique ID for features in the layer. The new attribute is not added to the input layer but a new layer is generated instead. The initial starting value for the incremental series can be specified. Specifying an optional modulus value will restart the count to START whenever the field value reaches the modulus value. Optionally, grouping fields can be specified. If group fields are present, then the field value will be reset for each combination of these group field values. The sort order for features may be specified, if so, then the incremental field will respect this sort order.

Usage

qgis_addautoincrementalfield(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELD_NAME = qgisprocess:::qgis_default_value(),
  START = qgisprocess:::qgis_default_value(),
  MODULUS = qgisprocess:::qgis_default_value(),
  GROUP_FIELDS = qgisprocess:::qgis_default_value(),
  SORT_EXPRESSION = qgisprocess:::qgis_default_value(),
  SORT_ASCENDING = qgisprocess:::qgis_default_value(),
  SORT_NULLS_FIRST = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	source - Input layer. Path to a vector layer.
FIELD_NAME	string - Field name. 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.
START	number - Start values at. 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.
MODULUS	number - Modulus value. 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.
GROUP_FIELDS	field - Group values by. The name of an existing field. ; delimited list of existing field names.
SORT_EXPRESSION	expression - Sort expression. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
SORT_ASCENDING	boolean - Sort ascending. 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.
SORT_NULLS_FIRST	boolean - Sort nulls first. 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.
OUTPUT	sink - Incremented. Path for new vector 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

• OUTPUT - outputVector - Incremented

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