sagang_geocoding: QGIS algorithm - Geocoding

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

QGIS algorithm - Geocoding

Description

QGIS Algorithm provided by SAGA Next Gen Geocoding (sagang:geocoding). —————- Arguments —————- LOCATIONS: Locations Argument type: vectorDestination Acceptable values: - Path for new vector layer ADDRESSES: Address List (optional) Argument type: source Acceptable values: - Path to a vector layer FIELD: Address Field Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names ADDRESS: Single Address Default value: Bundesstrasse 55, Hamburg, Germany Argument type: string Acceptable values: - String 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 PROVIDER: Service Provider Default value: 0 Argument type: enum Available values: - 0: (0) Nominatim (OpenStreetMap) - 1: (1) The Data Science Toolkit - 2: (2) Google - 3: (3) Bing - 4: (4) MapQuest Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' API_KEY: API Key Default value: Argument type: string Acceptable values: - String 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 METADATA: Store Metadata 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_geocoding(
  LOCATIONS = qgisprocess:::qgis_default_value(),
  ADDRESSES = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  ADDRESS = qgisprocess:::qgis_default_value(),
  PROVIDER = qgisprocess:::qgis_default_value(),
  API_KEY = qgisprocess:::qgis_default_value(),
  METADATA = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

LOCATIONS	vectorDestination - Locations. Path for new vector layer.
ADDRESSES	source - Address List. Path to a vector layer.
FIELD	field - Address Field. The name of an existing field. ; delimited list of existing field names.
ADDRESS	string - Single Address. String 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.
PROVIDER	enum of ⁠("(0) Nominatim (OpenStreetMap)", "(1) The Data Science Toolkit", "(2) Google", "(3) Bing", "(4) MapQuest")⁠ - Service Provider. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
API_KEY	string - API Key. String 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.
METADATA	boolean - Store Metadata. 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

• LOCATIONS - outputVector - Locations

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