qgis_pointsdisplacement: QGIS algorithm - Points displacement

View source: R/qgis_pointsdisplacement.R

qgis_pointsdisplacementR Documentation

QGIS algorithm - Points displacement

Description

QGIS Algorithm provided by QGIS Points displacement (qgis:pointsdisplacement). Offsets nearby point features by moving nearby points by a preset amount to minimize overlapping features.

Usage

qgis_pointsdisplacement(
  INPUT = qgisprocess:::qgis_default_value(),
  PROXIMITY = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  HORIZONTAL = qgisprocess:::qgis_default_value(),
  OUTPUT = 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.

PROXIMITY

distance - Minimum distance to other points. 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.

DISTANCE

distance - Displacement 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.

HORIZONTAL

boolean - Horizontal distribution for two point case. 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 - Displaced. 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 - Displaced


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