sagang_aggregatepointobservations: QGIS algorithm - Aggregate point observations

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

QGIS algorithm - Aggregate point observations

Description

QGIS Algorithm provided by SAGA Next Gen Aggregate point observations (sagang:aggregatepointobservations). —————- Arguments —————- REFERENCE: Reference Points Argument type: source Acceptable values: - Path to a vector layer REFERENCE_ID: ID Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names OBSERVATIONS: Observations Argument type: source Acceptable values: - Path to a vector layer X: X Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names Y: Y Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names TRACK: Track Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names DATE: Date Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names TIME: Time Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names PARAMETER: Parameter Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names AGGREGATED: Aggregated Argument type: vectorDestination Acceptable values: - Path for new vector layer TIME_SPAN: Time Span Aggregation Default value: 1 Argument type: enum Available values: - 0: (0) ignore - 1: (1) floating - 2: (2) fixed Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' FIX_TIME: Fixed Time Span (minutes) Default value: 20 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 OFF_TIME: Fixed Time Span Offset (minutes) Default value: -10 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 EPS_TIME: Maximum Time Span (Seconds) Default value: 60 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 EPS_SPACE: Maximum Distance Default value: 100 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 VERBOSE: Verbose Default value: false Argument type: boolean Acceptable values: - 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 POLAR: Polar Coordinates Default value: false Argument type: boolean Acceptable values: - 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

Usage

sagang_aggregatepointobservations(
  REFERENCE = qgisprocess:::qgis_default_value(),
  REFERENCE_ID = qgisprocess:::qgis_default_value(),
  OBSERVATIONS = qgisprocess:::qgis_default_value(),
  X = qgisprocess:::qgis_default_value(),
  Y = qgisprocess:::qgis_default_value(),
  TRACK = qgisprocess:::qgis_default_value(),
  DATE = qgisprocess:::qgis_default_value(),
  TIME = qgisprocess:::qgis_default_value(),
  PARAMETER = qgisprocess:::qgis_default_value(),
  AGGREGATED = qgisprocess:::qgis_default_value(),
  TIME_SPAN = qgisprocess:::qgis_default_value(),
  FIX_TIME = qgisprocess:::qgis_default_value(),
  OFF_TIME = qgisprocess:::qgis_default_value(),
  EPS_TIME = qgisprocess:::qgis_default_value(),
  EPS_SPACE = qgisprocess:::qgis_default_value(),
  VERBOSE = qgisprocess:::qgis_default_value(),
  POLAR = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

REFERENCE	source - Reference Points. Path to a vector layer.
REFERENCE_ID	field - ID. The name of an existing field. ; delimited list of existing field names.
OBSERVATIONS	source - Observations. Path to a vector layer.
X	field - X. The name of an existing field. ; delimited list of existing field names.
Y	field - Y. The name of an existing field. ; delimited list of existing field names.
TRACK	field - Track. The name of an existing field. ; delimited list of existing field names.
DATE	field - Date. The name of an existing field. ; delimited list of existing field names.
TIME	field - Time. The name of an existing field. ; delimited list of existing field names.
PARAMETER	field - Parameter. The name of an existing field. ; delimited list of existing field names.
AGGREGATED	vectorDestination - Aggregated. Path for new vector layer.
TIME_SPAN	enum of ⁠("(0) ignore", "(1) floating", "(2) fixed")⁠ - Time Span Aggregation. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
FIX_TIME	number - Fixed Time Span (minutes). 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.
OFF_TIME	number - Fixed Time Span Offset (minutes). 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.
EPS_TIME	number - Maximum Time Span (Seconds). 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.
EPS_SPACE	number - Maximum 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.
VERBOSE	boolean - Verbose. 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.
POLAR	boolean - Polar Coordinates. 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.
...	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

• AGGREGATED - outputVector - Aggregated

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