qgis_refactorfields: QGIS algorithm - Refactor fields

View source: R/qgis_refactorfields.R

qgis_refactorfieldsR Documentation

QGIS algorithm - Refactor fields

Description

QGIS Algorithm provided by QGIS (native c++) Refactor fields (native:refactorfields). This algorithm allows editing the structure of the attributes table of a vector layer. Fields can be modified in their type and name, using a fields mapping. The original layer is not modified. A new layer is generated, which contains a modified attribute table, according to the provided fields mapping. Rows in orange have constraints in the template layer from which these fields were loaded. Treat this information as a hint during configuration. No constraints will be added on an output layer nor will they be checked or enforced by the algorithm.

Usage

qgis_refactorfields(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELDS_MAPPING = 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_MAPPING

fields_mapping - Fields mapping. .

OUTPUT

sink - Refactored. 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 - Refactored


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