sagang_focalmechanismbeachballplots: QGIS algorithm - Focal mechanism (beachball plots)

View source: R/sagang_focalmechanismbeachballplots.R

sagang_focalmechanismbeachballplotsR Documentation

QGIS algorithm - Focal mechanism (beachball plots)

Description

QGIS Algorithm provided by SAGA Next Gen Focal mechanism (beachball plots) (sagang:focalmechanismbeachballplots). —————- Arguments —————- POINTS: Points Argument type: source Acceptable values: - Path to a vector layer STRIKE: Strike Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names DIP: Dip Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names RAKE: Rake Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names SIZE: Size Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names SIZE_DEF: Default Default value: 1 Argument type: number Acceptable values: - 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 PLOTS: Focal Mechanism Beachballs Argument type: vectorDestination Acceptable values: - Path for new vector layer DARC: Arc Vertex Distance (Degree) Default value: 5 Argument type: number Acceptable values: - 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 STYLE: Style Default value: 0 Argument type: enum Available values: - 0: (0) one - 1: (1) two Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_focalmechanismbeachballplots(
  POINTS = qgisprocess:::qgis_default_value(),
  STRIKE = qgisprocess:::qgis_default_value(),
  DIP = qgisprocess:::qgis_default_value(),
  RAKE = qgisprocess:::qgis_default_value(),
  SIZE = qgisprocess:::qgis_default_value(),
  SIZE_DEF = qgisprocess:::qgis_default_value(),
  PLOTS = qgisprocess:::qgis_default_value(),
  DARC = qgisprocess:::qgis_default_value(),
  STYLE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POINTS

source - Points. Path to a vector layer.

STRIKE

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

DIP

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

RAKE

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

SIZE

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

SIZE_DEF

number - Default. 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.

PLOTS

vectorDestination - Focal Mechanism Beachballs. Path for new vector layer.

DARC

number - Arc Vertex Distance (Degree). 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.

STYLE

enum of ⁠("(0) one", "(1) two")⁠ - Style. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

...

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

  • PLOTS - outputVector - Focal Mechanism Beachballs


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