qgis_pointstopath: QGIS algorithm - Points to path

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

QGIS algorithm - Points to path

Description

QGIS Algorithm provided by QGIS (native c++) Points to path (native:pointstopath). This algorithm takes a point layer and connects its features creating a new line layer. An attribute or expression may be specified to define the order the points should be connected. If no order expression is specified, the feature ID is used. A natural sort can be used when sorting by a string attribute or expression (ie. place 'a9' before 'a10'). An attribute or expression can be selected to group points having the same value into the same resulting line.

Usage

qgis_pointstopath(
  INPUT = qgisprocess:::qgis_default_value(),
  CLOSE_PATH = qgisprocess:::qgis_default_value(),
  ORDER_EXPRESSION = qgisprocess:::qgis_default_value(),
  NATURAL_SORT = qgisprocess:::qgis_default_value(),
  GROUP_EXPRESSION = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  OUTPUT_TEXT_DIR = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	source - Input layer. Path to a vector layer.
CLOSE_PATH	boolean - Create closed paths. 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.
ORDER_EXPRESSION	expression - Order expression. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
NATURAL_SORT	boolean - Sort text containing numbers naturally. 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.
GROUP_EXPRESSION	expression - Path group expression. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
OUTPUT	sink - Paths. Path for new vector layer.
OUTPUT_TEXT_DIR	folderDestination - Directory for text output. Path for an existing or new folder.
...	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

• NUM_PATHS - outputNumber - Number of paths

• OUTPUT - outputVector - Paths

• OUTPUT_TEXT_DIR - outputFolder - Directory for text output

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