grass_v_edit: QGIS algorithm - v.edit

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

QGIS algorithm - v.edit

Description

QGIS Algorithm provided by GRASS v.edit (grass:v.edit). Edits a vector map, allows adding, deleting and modifying selected vector features.

Usage

grass_v_edit(
  map = qgisprocess:::qgis_default_value(),
  type = qgisprocess:::qgis_default_value(),
  tool = qgisprocess:::qgis_default_value(),
  input = qgisprocess:::qgis_default_value(),
  move = qgisprocess:::qgis_default_value(),
  threshold = qgisprocess:::qgis_default_value(),
  ids = qgisprocess:::qgis_default_value(),
  cats = qgisprocess:::qgis_default_value(),
  coords = qgisprocess:::qgis_default_value(),
  bbox = qgisprocess:::qgis_default_value(),
  polygon = qgisprocess:::qgis_default_value(),
  where = qgisprocess:::qgis_default_value(),
  query = qgisprocess:::qgis_default_value(),
  bgmap = qgisprocess:::qgis_default_value(),
  snap = qgisprocess:::qgis_default_value(),
  zbulk = qgisprocess:::qgis_default_value(),
  .r = qgisprocess:::qgis_default_value(),
  .c = qgisprocess:::qgis_default_value(),
  .n = qgisprocess:::qgis_default_value(),
  .b = qgisprocess:::qgis_default_value(),
  .arg_1 = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_SNAP_TOLERANCE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_MIN_AREA_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_OUTPUT_TYPE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_DSCO = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_LCO = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_EXPORT_NOCAT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

map	source - Name of vector layer. Path to a vector layer.
type	enum of ⁠("point", "line", "boundary", "centroid")⁠ - Input feature type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
tool	enum of ⁠("create", "add", "delete", "copy", "move", "flip", "catadd", "catdel", "merge", "break", "snap", "connect", "chtype", "vertexadd", "vertexdel", "vertexmove", "areadel", "zbulk", "select")⁠ - Tool. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
input	file - ASCII file for add tool. Path to a file.
move	string - Difference in x,y,z direction for moving feature or vertex. 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.
threshold	string - Threshold distance (coords,snap,query). 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.
ids	string - Feature ids. 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.
cats	string - Category values. 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.
coords	string - List of point coordinates. 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.
bbox	extent - Bounding box for selecting features. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..
polygon	string - Polygon for selecting features. 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.
where	string - WHERE conditions of SQL statement without 'where' keyword. 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.
query	enum of ⁠("length", "dangle")⁠ - Query tool. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
bgmap	source - Name of background vector map. Path to a vector layer.
snap	enum of ⁠("no", "node", "vertex")⁠ - Snap added or modified features in the given threshold to the nearest existing feature. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
zbulk	string - Starting value and step for z bulk-labeling. Pair: value,step (e.g. 1100,10). 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.
.r	boolean - Reverse selection. 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. Original algorithm parameter name: -r.
.c	boolean - Close added boundaries (using threshold distance). 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. Original algorithm parameter name: -c.
.n	boolean - Do not expect header of input data. 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. Original algorithm parameter name: -n.
.b	boolean - Do not build topology. 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. Original algorithm parameter name: -b.
.arg_1	boolean - Modify only first found feature in bounding box. 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. Original algorithm parameter name: -1.
output	vectorDestination - Edited. Path for new vector layer.
GRASS_REGION_PARAMETER	extent - GRASS GIS region extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..
GRASS_SNAP_TOLERANCE_PARAMETER	number - v.in.ogr snap tolerance (-1 = no snap). 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.
GRASS_MIN_AREA_PARAMETER	number - v.in.ogr min area. 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.
GRASS_OUTPUT_TYPE_PARAMETER	enum of ⁠("auto", "point", "line", "area")⁠ - v.out.ogr output type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
GRASS_VECTOR_DSCO	string - v.out.ogr output data source options (dsco). 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.
GRASS_VECTOR_LCO	string - v.out.ogr output layer options (lco). 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.
GRASS_VECTOR_EXPORT_NOCAT	boolean - Also export features without category (not labeled). Otherwise only features with category are exported. 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.
...	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 - Edited

JanCaha/r_package_qgis documentation built on Aug. 4, 2024, 6:11 a.m.