qgis_addfieldtoattributestable: QGIS algorithm - Add field to attributes table

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

QGIS algorithm - Add field to attributes table

Description

QGIS Algorithm provided by QGIS (native c++) Add field to attributes table (native:addfieldtoattributestable). This algorithm adds a new attribute to a vector layer. The name and characteristics of the attribute are defined as parameters. The new attribute is not added to the input layer but a new layer is generated instead.

Usage

qgis_addfieldtoattributestable(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELD_NAME = qgisprocess:::qgis_default_value(),
  FIELD_TYPE = qgisprocess:::qgis_default_value(),
  FIELD_LENGTH = qgisprocess:::qgis_default_value(),
  FIELD_PRECISION = qgisprocess:::qgis_default_value(),
  FIELD_ALIAS = qgisprocess:::qgis_default_value(),
  FIELD_COMMENT = 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_NAME	string - 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.
FIELD_TYPE	enum of ⁠("Integer (32 bit)", "Decimal (double)", "Text (string)", "Boolean", "Date", "Time", "Date & Time", "Binary Object (BLOB)", "String List", "Integer List", "Decimal (double) List")⁠ - Field type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
FIELD_LENGTH	number - Field length. A numeric 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.
FIELD_PRECISION	number - Field precision. A numeric 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.
FIELD_ALIAS	string - Field alias. 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.
FIELD_COMMENT	string - Field comment. 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 - Added. 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 - Added

JanCaha/r_package_qgis documentation built on May 1, 2024, 3:30 a.m.