qgis_statisticsbycategories: QGIS algorithm - Statistics by categories

View source: R/qgis_statisticsbycategories.R

qgis_statisticsbycategoriesR Documentation

QGIS algorithm - Statistics by categories

Description

QGIS Algorithm provided by QGIS Statistics by categories (qgis:statisticsbycategories). This algorithm calculates statistics of fields depending on a parent class.

Usage

qgis_statisticsbycategories(
  INPUT = qgisprocess:::qgis_default_value(),
  VALUES_FIELD_NAME = qgisprocess:::qgis_default_value(),
  CATEGORIES_FIELD_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 vector layer. Path to a vector layer.

VALUES_FIELD_NAME

field - Field to calculate statistics on (if empty, only count is calculated). The name of an existing field. ; delimited list of existing field names.

CATEGORIES_FIELD_NAME

field - Field(s) with categories. The name of an existing field. ; delimited list of existing field names.

OUTPUT

sink - Statistics by category. 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 - Statistics by category


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