grass_r_mapcalc_simple: QGIS algorithm - r.mapcalc.simple

View source: R/grass_r_mapcalc_simple.R

grass_r_mapcalc_simpleR Documentation

QGIS algorithm - r.mapcalc.simple

Description

QGIS Algorithm provided by GRASS r.mapcalc.simple (grass:r.mapcalc.simple). Calculate new raster map from a r.mapcalc expression.

Usage

grass_r_mapcalc_simple(
  a = qgisprocess:::qgis_default_value(),
  b = qgisprocess:::qgis_default_value(),
  c = qgisprocess:::qgis_default_value(),
  d = qgisprocess:::qgis_default_value(),
  e = qgisprocess:::qgis_default_value(),
  f = qgisprocess:::qgis_default_value(),
  expression = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_OPT = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_META = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

a

raster - Raster layer A. Path to a raster layer.

b

raster - Raster layer B. Path to a raster layer.

c

raster - Raster layer C. Path to a raster layer.

d

raster - Raster layer D. Path to a raster layer.

e

raster - Raster layer E. Path to a raster layer.

f

raster - Raster layer F. Path to a raster layer.

expression

string - Formula. String 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

rasterDestination - Calculated. Path for new raster layer.

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_REGION_CELLSIZE_PARAMETER

number - GRASS GIS region cellsize (leave 0 for 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.

GRASS_RASTER_FORMAT_OPT

string - Output Rasters format options (createopt). String 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_RASTER_FORMAT_META

string - Output Rasters format metadata options (metaopt). String 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

  • output - outputRaster - Calculated


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