qgis_extractbyextent: QGIS algorithm - Extract/clip by extent

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

QGIS algorithm - Extract/clip by extent

Description

QGIS Algorithm provided by QGIS (native c++) Extract/clip by extent (native:extractbyextent). This algorithm creates a new vector layer that only contains features which fall within a specified extent. Any features which intersect the extent will be included. Optionally, feature geometries can also be clipped to the extent. If this option is selected, then the output geometries will automatically be converted to multi geometries to ensure uniform output geometry types.

Usage

qgis_extractbyextent(
  INPUT = qgisprocess:::qgis_default_value(),
  EXTENT = qgisprocess:::qgis_default_value(),
  CLIP = 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.
EXTENT	extent - Extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..
CLIP	boolean - Clip features to extent. 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.
OUTPUT	sink - Extracted. 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 - Extracted

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