grass_v_report: QGIS algorithm - v.report

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

QGIS algorithm - v.report

Description

QGIS Algorithm provided by GRASS v.report (grass:v.report). Reports geometry statistics for vectors.

Usage

grass_v_report(
  map = qgisprocess:::qgis_default_value(),
  option = qgisprocess:::qgis_default_value(),
  units = qgisprocess:::qgis_default_value(),
  sort = qgisprocess:::qgis_default_value(),
  html = 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(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

map	source - Input layer. Path to a vector layer.
option	enum of ⁠("area", "length", "coor")⁠ - Value to calculate. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
units	enum of ⁠("miles", "feet", "meters", "kilometers", "acres", "hectares", "percent")⁠ - units. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
sort	enum of ⁠("asc", "desc")⁠ - Sort the result (ascending, descending). Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
html	fileDestination - Report. Path for new file.
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.
...	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

• html - outputHtml - Report

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