qgis_hublines: QGIS algorithm - Join by lines (hub lines)

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

QGIS algorithm - Join by lines (hub lines)

Description

QGIS Algorithm provided by QGIS (native c++) Join by lines (hub lines) (native:hublines). Creates lines joining two point layers, based on a common attribute value. This algorithm creates hub and spoke diagrams by connecting lines from points on the Spoke layer to matching points in the Hub layer. Determination of which hub goes with each point is based on a match between the Hub ID field on the hub points and the Spoke ID field on the spoke points. If input layers are not point layers, a point on the surface of the geometries will be taken as the connecting location. Optionally, geodesic lines can be created, which represent the shortest path on the surface of an ellipsoid. When geodesic mode is used, it is possible to split the created lines at the antimeridian (±180 degrees longitude), which can improve rendering of the lines. Additionally, the distance between vertices can be specified. A smaller distance results in a denser, more accurate line. —————- Notes —————- - This algorithm drops existing primary keys or FID values and regenerates them in output layers.

Usage

qgis_hublines(
  HUBS = qgisprocess:::qgis_default_value(),
  HUB_FIELD = qgisprocess:::qgis_default_value(),
  HUB_FIELDS = qgisprocess:::qgis_default_value(),
  SPOKES = qgisprocess:::qgis_default_value(),
  SPOKE_FIELD = qgisprocess:::qgis_default_value(),
  SPOKE_FIELDS = qgisprocess:::qgis_default_value(),
  GEODESIC = qgisprocess:::qgis_default_value(),
  GEODESIC_DISTANCE = qgisprocess:::qgis_default_value(),
  ANTIMERIDIAN_SPLIT = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

HUBS	source - Hub layer. Path to a vector layer.
HUB_FIELD	field - Hub ID field. The name of an existing field. ; delimited list of existing field names.
HUB_FIELDS	field - Hub layer fields to copy (leave empty to copy all fields). The name of an existing field. ; delimited list of existing field names.
SPOKES	source - Spoke layer. Path to a vector layer.
SPOKE_FIELD	field - Spoke ID field. The name of an existing field. ; delimited list of existing field names.
SPOKE_FIELDS	field - Spoke layer fields to copy (leave empty to copy all fields). The name of an existing field. ; delimited list of existing field names.
GEODESIC	boolean - Create geodesic lines. 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.
GEODESIC_DISTANCE	distance - Distance between vertices (geodesic lines only). 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.
ANTIMERIDIAN_SPLIT	boolean - Split lines at antimeridian (±180 degrees longitude). 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.
OUTPUT	sink - Hub lines. 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 lines

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