qgis_renametablefield: QGIS algorithm - Rename field

View source: R/qgis_renametablefield.R

qgis_renametablefieldR Documentation

QGIS algorithm - Rename field

Description

QGIS Algorithm provided by QGIS (native c++) Rename field (native:renametablefield). Renames an existing field from a vector layer. This algorithm renames an existing field from a vector layer.

Usage

qgis_renametablefield(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  NEW_NAME = 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 - Field to rename. The name of an existing field. ; delimited list of existing field names.

NEW_NAME

string - New field 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.

OUTPUT

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


JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.