qgis_boxplot: QGIS algorithm - Box plot

View source: R/qgis_boxplot.R

qgis_boxplotR Documentation

QGIS algorithm - Box plot

Description

QGIS Algorithm provided by QGIS Box plot (qgis:boxplot). This algorithm creates a box plot from a category and a layer field.

Usage

qgis_boxplot(
  INPUT = qgisprocess:::qgis_default_value(),
  NAME_FIELD = qgisprocess:::qgis_default_value(),
  VALUE_FIELD = qgisprocess:::qgis_default_value(),
  MSD = 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.

NAME_FIELD

field - Category name field. The name of an existing field. ; delimited list of existing field names.

VALUE_FIELD

field - Value field. The name of an existing field. ; delimited list of existing field names.

MSD

enum of ⁠("Show Mean", "Show Standard Deviation", "Don't show Mean and Standard Deviation")⁠ - Additional Statistic Lines. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

OUTPUT

fileDestination - Box plot. 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 - Box plot


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