sagang_polygoncentroids: QGIS algorithm - Polygon centroids

View source: R/sagang_polygoncentroids.R

sagang_polygoncentroidsR Documentation

QGIS algorithm - Polygon centroids

Description

QGIS Algorithm provided by SAGA Next Gen Polygon centroids (sagang:polygoncentroids). —————- Arguments —————- POLYGONS: Polygons Argument type: source Acceptable values: - Path to a vector layer CENTROIDS: Centroids Argument type: vectorDestination Acceptable values: - Path for new vector layer METHOD: Centroids for each part 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 INSIDE: Force Inside 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

Usage

sagang_polygoncentroids(
  POLYGONS = qgisprocess:::qgis_default_value(),
  CENTROIDS = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  INSIDE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POLYGONS

source - Polygons. Path to a vector layer.

CENTROIDS

vectorDestination - Centroids. Path for new vector layer.

METHOD

boolean - Centroids for each part. 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.

INSIDE

boolean - Force Inside. 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

  • CENTROIDS - outputVector - Centroids


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