gdal_clipvectorbypolygon: QGIS algorithm - Clip vector by mask layer

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

QGIS algorithm - Clip vector by mask layer

Description

QGIS Algorithm provided by GDAL Clip vector by mask layer (gdal:clipvectorbypolygon). —————- Arguments —————- INPUT: Input layer Argument type: source Acceptable values: - Path to a vector layer MASK: Mask layer Argument type: source Acceptable values: - Path to a vector layer 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: Clipped (mask) Argument type: vectorDestination Acceptable values: - Path for new vector layer

Usage

gdal_clipvectorbypolygon(
  INPUT = qgisprocess:::qgis_default_value(),
  MASK = 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.
MASK	source - Mask layer. Path to a vector layer.
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 - Clipped (mask). 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 - Clipped (mask)

JanCaha/r_package_qgis documentation built on May 1, 2024, 3:30 a.m.