qgis_vectorlayerhistogram: QGIS algorithm - Vector layer histogram

View source: R/qgis_vectorlayerhistogram.R

qgis_vectorlayerhistogramR Documentation

QGIS algorithm - Vector layer histogram

Description

QGIS Algorithm provided by QGIS Vector layer histogram (qgis:vectorlayerhistogram). This algorithm generates a histogram with the values of the attribute of a vector layer. The attribute to use for computing the histogram must be a numeric attribute.

Usage

qgis_vectorlayerhistogram(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  BINS = 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 - Attribute. The name of an existing field. ; delimited list of existing field names.

BINS

number - number of bins. 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.

OUTPUT

fileDestination - Histogram. Path for new file.

...

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 - outputHtml - Histogram


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