sagang_soilwaterbalancedays: QGIS algorithm - Soil water balance (days)

View source: R/sagang_soilwaterbalancedays.R

sagang_soilwaterbalancedaysR Documentation

QGIS algorithm - Soil water balance (days)

Description

QGIS Algorithm provided by SAGA Next Gen Soil water balance (days) (sagang:soilwaterbalancedays). —————- Arguments —————- TAVG: Mean Temperature Argument type: multilayer TMIN: Minimum Temperature Argument type: multilayer TMAX: Maximum Temperature Argument type: multilayer PSUM: Precipitation Argument type: multilayer SNOW: Snow Depth Argument type: rasterDestination Acceptable values: - Path for new raster layer SW_0: Soil Water (Upper Layer) Argument type: rasterDestination Acceptable values: - Path for new raster layer SW_1: Soil Water (Lower Layer) Argument type: rasterDestination Acceptable values: - Path for new raster layer LAT_GRID: Latitude (optional) Argument type: raster Acceptable values: - Path to a raster layer LAT_CONST: Default Latitude Default value: 50 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 SWC: Soil Water Capacity of Profile (optional) Argument type: raster Acceptable values: - Path to a raster layer SWC_DEFAULT: Default Default value: 220 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 SWC_SURFACE: Top Soil Water Capacity Default value: 30 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 SWT_RESIST: Transpiration Resistance Default value: 0.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 RESET: Reset Default value: true Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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 DAY: Start Day Default value: 2021-03-24 Argument type: string Acceptable values: - 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

Usage

sagang_soilwaterbalancedays(
  TAVG = qgisprocess:::qgis_default_value(),
  TMIN = qgisprocess:::qgis_default_value(),
  TMAX = qgisprocess:::qgis_default_value(),
  PSUM = qgisprocess:::qgis_default_value(),
  SNOW = qgisprocess:::qgis_default_value(),
  SW_0 = qgisprocess:::qgis_default_value(),
  SW_1 = qgisprocess:::qgis_default_value(),
  LAT_GRID = qgisprocess:::qgis_default_value(),
  LAT_CONST = qgisprocess:::qgis_default_value(),
  SWC = qgisprocess:::qgis_default_value(),
  SWC_DEFAULT = qgisprocess:::qgis_default_value(),
  SWC_SURFACE = qgisprocess:::qgis_default_value(),
  SWT_RESIST = qgisprocess:::qgis_default_value(),
  RESET = qgisprocess:::qgis_default_value(),
  DAY = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

TAVG

multilayer - Mean Temperature. .

TMIN

multilayer - Minimum Temperature. .

TMAX

multilayer - Maximum Temperature. .

PSUM

multilayer - Precipitation. .

SNOW

rasterDestination - Snow Depth. Path for new raster layer.

SW_0

rasterDestination - Soil Water (Upper Layer). Path for new raster layer.

SW_1

rasterDestination - Soil Water (Lower Layer). Path for new raster layer.

LAT_GRID

raster - Latitude. Path to a raster layer.

LAT_CONST

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

SWC

raster - Soil Water Capacity of Profile. Path to a raster layer.

SWC_DEFAULT

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.

SWC_SURFACE

number - Top Soil Water Capacity. 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.

SWT_RESIST

number - Transpiration Resistance. 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.

RESET

boolean - Reset. 1 for true/yes. 0 for false/no. 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.

DAY

string - Start Day. 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

  • SNOW - outputRaster - Snow Depth

  • SW_0 - outputRaster - Soil Water (Upper Layer)

  • SW_1 - outputRaster - Soil Water (Lower Layer)


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