sagang_clippointswithpolygons: QGIS algorithm - Clip points with polygons

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

QGIS algorithm - Clip points with polygons

Description

QGIS Algorithm provided by SAGA Next Gen Clip points with polygons (sagang:clippointswithpolygons). —————- Arguments —————- POINTS: Points Argument type: source Acceptable values: - Path to a vector layer POLYGONS: Polygons Argument type: source Acceptable values: - Path to a vector layer FIELD: Add Attribute to Clipped Points Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names CLIPS: Clipped Points Argument type: vectorDestination Acceptable values: - Path for new vector layer METHOD: Clipping Options Default value: 0 Argument type: enum Available values: - 0: (0) one layer for all points - 1: (1) separate layer for each polygon Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_clippointswithpolygons(
  POINTS = qgisprocess:::qgis_default_value(),
  POLYGONS = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  CLIPS = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POINTS	source - Points. Path to a vector layer.
POLYGONS	source - Polygons. Path to a vector layer.
FIELD	field - Add Attribute to Clipped Points. The name of an existing field. ; delimited list of existing field names.
CLIPS	vectorDestination - Clipped Points. Path for new vector layer.
METHOD	enum of ⁠("(0) one layer for all points", "(1) separate layer for each polygon")⁠ - Clipping Options. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
...	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

• CLIPS - outputVector - Clipped Points

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