sagang_snappointstolines: QGIS algorithm - Snap points to lines

View source: R/sagang_snappointstolines.R

sagang_snappointstolinesR Documentation

QGIS algorithm - Snap points to lines

Description

QGIS Algorithm provided by SAGA Next Gen Snap points to lines (sagang:snappointstolines). —————- Arguments —————- INPUT: Points Argument type: source Acceptable values: - Path to a vector layer SNAP: Snap Features Argument type: source Acceptable values: - Path to a vector layer OUTPUT: Result Argument type: vectorDestination Acceptable values: - Path for new vector layer MOVES: Moves Argument type: vectorDestination Acceptable values: - Path for new vector layer DISTANCE: Search Distance Default value: 0 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

Usage

sagang_snappointstolines(
  INPUT = qgisprocess:::qgis_default_value(),
  SNAP = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  MOVES = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

source - Points. Path to a vector layer.

SNAP

source - Snap Features. Path to a vector layer.

OUTPUT

vectorDestination - Result. Path for new vector layer.

MOVES

vectorDestination - Moves. Path for new vector layer.

DISTANCE

number - Search Distance. 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.

...

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

  • MOVES - outputVector - Moves

  • OUTPUT - outputVector - Result


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