qgis_savefeatures: QGIS algorithm - Save vector features to file

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

QGIS algorithm - Save vector features to file

Description

QGIS Algorithm provided by QGIS (native c++) Save vector features to file (native:savefeatures). This algorithm saves vector features to a specified file dataset. For dataset formats supporting layers, an optional layer name parameter can be used to specify a custom string. Optional GDAL-defined dataset and layer options can be specified. For more information on this, read the online GDAL documentation.

Usage

qgis_savefeatures(
  INPUT = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  LAYER_NAME = qgisprocess:::qgis_default_value(),
  DATASOURCE_OPTIONS = qgisprocess:::qgis_default_value(),
  LAYER_OPTIONS = qgisprocess:::qgis_default_value(),
  ACTION_ON_EXISTING_FILE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	source - Vector features. Path to a vector layer.
OUTPUT	fileDestination - Saved features. Path for new file.
LAYER_NAME	string - Layer name. 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.
DATASOURCE_OPTIONS	string - GDAL dataset options (separate individual options with semicolons). 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.
LAYER_OPTIONS	string - GDAL layer options (separate individual options with semicolons). 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.
ACTION_ON_EXISTING_FILE	enum of ⁠("Create or overwrite file", "Create or overwrite layer", "Append features to existing layer, but do not create new fields", "Append features to existing layer, and create new fields if needed")⁠ - Action to take on pre-existing file. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
...	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

• FILE_PATH - outputString - File name and path

• LAYER_NAME - outputString - Layer name

• OUTPUT - outputFile - Saved features

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