sagang_pointtopointdistances: QGIS algorithm - Point to point distances

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - Point to point distances

Description

QGIS Algorithm provided by SAGA Next Gen Point to point distances (sagang:pointtopointdistances). —————- Arguments —————- POINTS: Points Argument type: source Acceptable values: - Path to a vector layer ID_POINTS: Identifier Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names NEAR: Near Points (optional) Argument type: source Acceptable values: - Path to a vector layer ID_NEAR: Identifier Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names DISTANCES: Distances Argument type: vectorDestination Acceptable values: - Path for new vector layer LINES: Distances as Lines Argument type: vectorDestination Acceptable values: - Path for new vector layer FORMAT: Output Format Default value: 1 Argument type: enum Available values: - 0: (0) complete input times near points matrix - 1: (1) each pair with a single record - 2: (2) find only the nearest point for each input point Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' MAX_DIST: Maximum 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_pointtopointdistances(
  POINTS = qgisprocess:::qgis_default_value(),
  ID_POINTS = qgisprocess:::qgis_default_value(),
  NEAR = qgisprocess:::qgis_default_value(),
  ID_NEAR = qgisprocess:::qgis_default_value(),
  DISTANCES = qgisprocess:::qgis_default_value(),
  LINES = qgisprocess:::qgis_default_value(),
  FORMAT = qgisprocess:::qgis_default_value(),
  MAX_DIST = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POINTS	source - Points. Path to a vector layer.
ID_POINTS	field - Identifier. The name of an existing field. ; delimited list of existing field names.
NEAR	source - Near Points. Path to a vector layer.
ID_NEAR	field - Identifier. The name of an existing field. ; delimited list of existing field names.
DISTANCES	vectorDestination - Distances. Path for new vector layer.
LINES	vectorDestination - Distances as Lines. Path for new vector layer.
FORMAT	enum of ⁠("(0) complete input times near points matrix", "(1) each pair with a single record", "(2) find only the nearest point for each input point")⁠ - Output Format. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
MAX_DIST	number - Maximum 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

• DISTANCES - outputVector - Distances

• LINES - outputVector - Distances as Lines

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