qgis_distancetonearesthublinetohub: QGIS algorithm - Distance to nearest hub (line to hub)

View source: R/qgis_distancetonearesthublinetohub.R

qgis_distancetonearesthublinetohubR Documentation

QGIS algorithm - Distance to nearest hub (line to hub)

Description

QGIS Algorithm provided by QGIS Distance to nearest hub (line to hub) (qgis:distancetonearesthublinetohub). Given an origin and a destination layers, this algorithm computes the distance between origin features and their closest destination one. Distance calculations are based on the features center. The resulting layer contains lines linking each origin point with its nearest destination feature.

Usage

qgis_distancetonearesthublinetohub(
  INPUT = qgisprocess:::qgis_default_value(),
  HUBS = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  UNIT = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

source - Source points layer. Path to a vector layer.

HUBS

source - Destination hubs layer. Path to a vector layer.

FIELD

field - Hub layer name attribute. The name of an existing field. ; delimited list of existing field names.

UNIT

enum of ⁠("Meters", "Feet", "Miles", "Kilometers", "Layer units")⁠ - Measurement unit. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

OUTPUT

sink - Hub distance. 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 - Hub distance


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