sagang_polygonclipping: QGIS algorithm - Polygon clipping

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

QGIS algorithm - Polygon clipping

Description

QGIS Algorithm provided by SAGA Next Gen Polygon clipping (sagang:polygonclipping). —————- Arguments —————- CLIP: Clip Features Argument type: source Acceptable values: - Path to a vector layer S_INPUT: Input Features Argument type: source Acceptable values: - Path to a vector layer S_OUTPUT: Output Features Argument type: vectorDestination Acceptable values: - Path for new vector layer M_INPUT: Input Features Argument type: multilayer M_OUTPUT: Output Features Argument type: vectorDestination Acceptable values: - Path for new vector layer DISSOLVE: Dissolve Clip Features Default value: true 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 MULTIPLE: Multiple Input Features Default value: true 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_polygonclipping(
  CLIP = qgisprocess:::qgis_default_value(),
  S_INPUT = qgisprocess:::qgis_default_value(),
  S_OUTPUT = qgisprocess:::qgis_default_value(),
  M_INPUT = qgisprocess:::qgis_default_value(),
  M_OUTPUT = qgisprocess:::qgis_default_value(),
  DISSOLVE = qgisprocess:::qgis_default_value(),
  MULTIPLE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

CLIP	source - Clip Features. Path to a vector layer.
S_INPUT	source - Input Features. Path to a vector layer.
S_OUTPUT	vectorDestination - Output Features. Path for new vector layer.
M_INPUT	multilayer - Input Features. .
M_OUTPUT	vectorDestination - Output Features. Path for new vector layer.
DISSOLVE	boolean - Dissolve Clip 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.
MULTIPLE	boolean - Multiple Input 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.
...	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

• M_OUTPUT - outputVector - Output Features

• S_OUTPUT - outputVector - Output Features

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