qgis_polygonfromlayerextent: QGIS algorithm - Extract layer extent

View source: R/qgis_polygonfromlayerextent.R

qgis_polygonfromlayerextentR Documentation

QGIS algorithm - Extract layer extent

Description

QGIS Algorithm provided by QGIS (native c++) Extract layer extent (native:polygonfromlayerextent). This algorithm takes a map layer and generates a new vector layer with the minimum bounding box (rectangle polygon with N-S orientation) that covers the input layer. Optionally, the extent can be enlarged to a rounded value.

Usage

qgis_polygonfromlayerextent(
  INPUT = qgisprocess:::qgis_default_value(),
  ROUND_TO = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

layer - Input layer. Path to a vector, raster or mesh layer.

ROUND_TO

distance - Round values to. 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.

OUTPUT

sink - Extent. 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 - Extent


JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.