qgis_nearestneighbouranalysis: QGIS algorithm - Nearest neighbour analysis

View source: R/qgis_nearestneighbouranalysis.R

qgis_nearestneighbouranalysisR Documentation

QGIS algorithm - Nearest neighbour analysis

Description

QGIS Algorithm provided by QGIS (native c++) Nearest neighbour analysis (native:nearestneighbouranalysis). This algorithm performs nearest neighbor analysis for a point layer. The output describes how the data are distributed (clustered, randomly or distributed). Output is generated as an HTML file with the computed statistical values.

Usage

qgis_nearestneighbouranalysis(
  INPUT = qgisprocess:::qgis_default_value(),
  OUTPUT_HTML_FILE = 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.

OUTPUT_HTML_FILE

fileDestination - Nearest neighbour. Path for new file.

...

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

  • EXPECTED_MD - outputNumber - Expected mean distance

  • NN_INDEX - outputNumber - Nearest neighbour index

  • OBSERVED_MD - outputNumber - Observed mean distance

  • OUTPUT_HTML_FILE - outputHtml - Nearest neighbour

  • POINT_COUNT - outputNumber - Number of points

  • Z_SCORE - outputNumber - Z-score


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