sagang_intersect: QGIS algorithm - Intersect

View source: R/sagang_intersect.R

sagang_intersectR Documentation

QGIS algorithm - Intersect

Description

QGIS Algorithm provided by SAGA Next Gen Intersect (sagang:intersect). —————- Arguments —————- A: Layer A Argument type: source Acceptable values: - Path to a vector layer B: Layer B Argument type: source Acceptable values: - Path to a vector layer RESULT: Intersect Argument type: vectorDestination Acceptable values: - Path for new vector layer SPLIT: Split Parts 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_intersect(
  A = qgisprocess:::qgis_default_value(),
  B = qgisprocess:::qgis_default_value(),
  RESULT = qgisprocess:::qgis_default_value(),
  SPLIT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

A

source - Layer A. Path to a vector layer.

B

source - Layer B. Path to a vector layer.

RESULT

vectorDestination - Intersect. Path for new vector layer.

SPLIT

boolean - Split Parts. 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

  • RESULT - outputVector - Intersect


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