sagang_warpingshapes: QGIS algorithm - Warping shapes

View source: R/sagang_warpingshapes.R

sagang_warpingshapesR Documentation

QGIS algorithm - Warping shapes

Description

QGIS Algorithm provided by SAGA Next Gen Warping shapes (sagang:warpingshapes). —————- Arguments —————- REF_SOURCE: Reference Points (Origin) Argument type: source Acceptable values: - Path to a vector layer REF_TARGET: Reference Points (Projection) (optional) Argument type: source Acceptable values: - Path to a vector layer XFIELD: x Position Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names YFIELD: y Position Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names METHOD: Method Default value: 0 Argument type: enum Available values: - 0: (0) Automatic - 1: (1) Triangulation - 2: (2) Spline - 3: (3) Affine - 4: (4) 1st Order Polynomial - 5: (5) 2nd Order Polynomial - 6: (6) 3rd Order Polynomial - 7: (7) Polynomial, Order Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' ORDER: Polynomial Order Default value: 3 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 INPUT: Input Argument type: source Acceptable values: - Path to a vector layer OUTPUT: Output Argument type: vectorDestination Acceptable values: - Path for new vector layer

Usage

sagang_warpingshapes(
  REF_SOURCE = qgisprocess:::qgis_default_value(),
  REF_TARGET = qgisprocess:::qgis_default_value(),
  XFIELD = qgisprocess:::qgis_default_value(),
  YFIELD = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  ORDER = qgisprocess:::qgis_default_value(),
  INPUT = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

REF_SOURCE

source - Reference Points (Origin). Path to a vector layer.

REF_TARGET

source - Reference Points (Projection). Path to a vector layer.

XFIELD

field - x Position. The name of an existing field. ; delimited list of existing field names.

YFIELD

field - y Position. The name of an existing field. ; delimited list of existing field names.

METHOD

enum of ⁠("(0) Automatic", "(1) Triangulation", "(2) Spline", "(3) Affine", "(4) 1st Order Polynomial", "(5) 2nd Order Polynomial", "(6) 3rd Order Polynomial", "(7) Polynomial, Order")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

ORDER

number - Polynomial Order. 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.

INPUT

source - Input. Path to a vector layer.

OUTPUT

vectorDestination - Output. 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 - Output


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