sagang_populatepolygonswithpoints: QGIS algorithm - Populate polygons with points

View source: R/sagang_populatepolygonswithpoints.R

sagang_populatepolygonswithpointsR Documentation

QGIS algorithm - Populate polygons with points

Description

QGIS Algorithm provided by SAGA Next Gen Populate polygons with points (sagang:populatepolygonswithpoints). —————- Arguments —————- POLYGONS: Polygons Argument type: source Acceptable values: - Path to a vector layer POINTS: Points Argument type: vectorDestination Acceptable values: - Path for new vector layer NUMFIELD: Number of Points Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names NUMPOINTS: Number of Points Default value: 100 Argument type: number Acceptable values: - 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 MAXITER: Maximum Iterations Default value: 30 Argument type: number Acceptable values: - 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

Usage

sagang_populatepolygonswithpoints(
  POLYGONS = qgisprocess:::qgis_default_value(),
  POINTS = qgisprocess:::qgis_default_value(),
  NUMFIELD = qgisprocess:::qgis_default_value(),
  NUMPOINTS = qgisprocess:::qgis_default_value(),
  MAXITER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POLYGONS

source - Polygons. Path to a vector layer.

POINTS

vectorDestination - Points. Path for new vector layer.

NUMFIELD

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

NUMPOINTS

number - Number of Points. 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.

MAXITER

number - Maximum Iterations. 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

  • POINTS - outputVector - Points


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