sagang_spatialpointpatternanalysis: QGIS algorithm - Spatial point pattern analysis

View source: R/sagang_spatialpointpatternanalysis.R

sagang_spatialpointpatternanalysisR Documentation

QGIS algorithm - Spatial point pattern analysis

Description

QGIS Algorithm provided by SAGA Next Gen Spatial point pattern analysis (sagang:spatialpointpatternanalysis). —————- Arguments —————- POINTS: Points Argument type: source Acceptable values: - Path to a vector layer WEIGHT: Weight Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names CENTRE: Mean Centre Argument type: vectorDestination Acceptable values: - Path for new vector layer STDDIST: Standard Distance Argument type: vectorDestination Acceptable values: - Path for new vector layer STEP: Vertex Distance (Degree) Default value: 5 Argument type: number Acceptable values: - 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 BBOX: Bounding Box Argument type: vectorDestination Acceptable values: - Path for new vector layer

Usage

sagang_spatialpointpatternanalysis(
  POINTS = qgisprocess:::qgis_default_value(),
  WEIGHT = qgisprocess:::qgis_default_value(),
  CENTRE = qgisprocess:::qgis_default_value(),
  STDDIST = qgisprocess:::qgis_default_value(),
  STEP = qgisprocess:::qgis_default_value(),
  BBOX = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POINTS

source - Points. Path to a vector layer.

WEIGHT

field - Weight. The name of an existing field. ; delimited list of existing field names.

CENTRE

vectorDestination - Mean Centre. Path for new vector layer.

STDDIST

vectorDestination - Standard Distance. Path for new vector layer.

STEP

number - Vertex Distance (Degree). 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.

BBOX

vectorDestination - Bounding Box. 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

  • BBOX - outputVector - Bounding Box

  • CENTRE - outputVector - Mean Centre

  • STDDIST - outputVector - Standard Distance


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