sagang_splitshapeslayer: QGIS algorithm - Split shapes layer

View source: R/sagang_splitshapeslayer.R

sagang_splitshapeslayerR Documentation

QGIS algorithm - Split shapes layer

Description

QGIS Algorithm provided by SAGA Next Gen Split shapes layer (sagang:splitshapeslayer). —————- Arguments —————- SHAPES: Shapes Argument type: source Acceptable values: - Path to a vector layer CUTS: Tiles Argument type: vectorDestination Acceptable values: - Path for new vector layer EXTENT: Extent Argument type: vectorDestination Acceptable values: - Path for new vector layer NX: Number of horizontal tiles Default value: 2 Argument type: number Acceptable values: - 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 NY: Number of vertical tiles Default value: 2 Argument type: number Acceptable values: - 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 METHOD: Method Default value: 0 Argument type: enum Available values: - 0: (0) completely contained - 1: (1) intersects - 2: (2) center Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_splitshapeslayer(
  SHAPES = qgisprocess:::qgis_default_value(),
  CUTS = qgisprocess:::qgis_default_value(),
  EXTENT = qgisprocess:::qgis_default_value(),
  NX = qgisprocess:::qgis_default_value(),
  NY = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

SHAPES

source - Shapes. Path to a vector layer.

CUTS

vectorDestination - Tiles. Path for new vector layer.

EXTENT

vectorDestination - Extent. Path for new vector layer.

NX

number - Number of horizontal tiles. 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.

NY

number - Number of vertical tiles. 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.

METHOD

enum of ⁠("(0) completely contained", "(1) intersects", "(2) center")⁠ - Method. 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

  • CUTS - outputVector - Tiles

  • EXTENT - outputVector - Extent


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