qgis_retainfields: QGIS algorithm - Retain fields

View source: R/qgis_retainfields.R

qgis_retainfieldsR Documentation

QGIS algorithm - Retain fields

Description

QGIS Algorithm provided by QGIS (native c++) Retain fields (native:retainfields). Retains selected fields from a vector layer. This algorithm takes a vector layer and generates a new one that retains only the selected fields. All other fields will be dropped.

Usage

qgis_retainfields(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELDS = 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.

FIELDS

field - Fields to retain. The name of an existing field. ; delimited list of existing field names.

OUTPUT

sink - Retained fields. 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

  • OUTPUT - outputVector - Retained fields


JanCaha/r_package_qgis documentation built on March 5, 2024, 3:12 p.m.