qgis_aggregate: QGIS algorithm - Aggregate

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

QGIS algorithm - Aggregate

Description

QGIS Algorithm provided by QGIS (native c++) Aggregate (native:aggregate). This algorithm take a vector or table layer and aggregate features based on a group by expression. Features for which group by expression return the same value are grouped together. It is possible to group all source features together using constant value in group by parameter, example: NULL. It is also possible to group features using multiple fields using Array function, example: Array("Field1", "Field2"). Geometries (if present) are combined into one multipart geometry for each group. Output attributes are computed depending on each given aggregate definition.

Usage

qgis_aggregate(
  INPUT = qgisprocess:::qgis_default_value(),
  GROUP_BY = qgisprocess:::qgis_default_value(),
  AGGREGATES = 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.
GROUP_BY	expression - Group by expression (NULL to group all features). A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
AGGREGATES	aggregates - Aggregates. .
OUTPUT	sink - Aggregated. 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 - Aggregated

JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.