gdal_dissolve: QGIS algorithm - Dissolve

View source: R/gdal_dissolve.R

gdal_dissolveR Documentation

QGIS algorithm - Dissolve

Description

QGIS Algorithm provided by GDAL Dissolve (gdal:dissolve). —————- Arguments —————- INPUT: Input layer Argument type: source Acceptable values: - Path to a vector layer FIELD: Dissolve field (optional) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names GEOMETRY: Geometry column name Default value: geometry Argument type: string Acceptable values: - 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 EXPLODE_COLLECTIONS: Produce one feature for each geometry in any kind of geometry collection in the source file 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 KEEP_ATTRIBUTES: Keep input attributes 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 COUNT_FEATURES: Count dissolved features 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 COMPUTE_AREA: Compute area and perimeter of dissolved features 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 COMPUTE_STATISTICS: Compute min/max/sum/mean for attribute 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 STATISTICS_ATTRIBUTE: Numeric attribute to calculate statistics on (optional) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names OPTIONS: Additional creation options (optional) Default value: Argument type: string Acceptable values: - 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 OUTPUT: Dissolved Argument type: vectorDestination Acceptable values: - Path for new vector layer

Usage

gdal_dissolve(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  GEOMETRY = qgisprocess:::qgis_default_value(),
  EXPLODE_COLLECTIONS = qgisprocess:::qgis_default_value(),
  KEEP_ATTRIBUTES = qgisprocess:::qgis_default_value(),
  COUNT_FEATURES = qgisprocess:::qgis_default_value(),
  COMPUTE_AREA = qgisprocess:::qgis_default_value(),
  COMPUTE_STATISTICS = qgisprocess:::qgis_default_value(),
  STATISTICS_ATTRIBUTE = qgisprocess:::qgis_default_value(),
  OPTIONS = 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

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

GEOMETRY

string - Geometry column 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.

EXPLODE_COLLECTIONS

boolean - Produce one feature for each geometry in any kind of geometry collection in the source file. 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.

KEEP_ATTRIBUTES

boolean - Keep input attributes. 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.

COUNT_FEATURES

boolean - Count dissolved features. 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.

COMPUTE_AREA

boolean - Compute area and perimeter of dissolved features. 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.

COMPUTE_STATISTICS

boolean - Compute min/max/sum/mean for attribute. 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.

STATISTICS_ATTRIBUTE

field - Numeric attribute to calculate statistics on. The name of an existing field. ; delimited list of existing field names.

OPTIONS

string - Additional creation options. 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.

OUTPUT

vectorDestination - Dissolved. 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 - Dissolved


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