qgis_splitvectorlayer: QGIS algorithm - Split vector layer

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

QGIS algorithm - Split vector layer

Description

QGIS Algorithm provided by QGIS (native c++) Split vector layer (native:splitvectorlayer). Splits input vector layer into multiple layers by specified unique ID field. Each of the layers created in the output folder contains all features from the input layer with the same value for the specified attribute. The number of files generated is equal to the number of different values found for the specified attribute.

Usage

qgis_splitvectorlayer(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  PREFIX_FIELD = qgisprocess:::qgis_default_value(),
  FILE_TYPE = qgisprocess:::qgis_default_value(),
  OUTPUT = 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.
FIELD	field - Unique ID field. The name of an existing field. ; delimited list of existing field names.
PREFIX_FIELD	boolean - Add field prefix to file names. 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.
FILE_TYPE	enum of ⁠("gpkg", "shp", "000", "csv", "dgn", "dxf", "fgb", "geojson", "geojsonl", "geojsons", "gml", "gpx", "gxt", "ili", "itf", "json", "kml", "ods", "sql", "sqlite", "tab", "txt", "xlsx", "xml", "xtf")⁠ - Output file type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
OUTPUT	folderDestination - Output directory. Path for an existing or new folder.
...	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

• OUTPUT - outputFolder - Output directory

• OUTPUT_LAYERS - outputMultilayer - Output layers

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