grass_r_topmodel: QGIS algorithm - r.topmodel

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - r.topmodel

Description

QGIS Algorithm provided by GRASS r.topmodel (grass:r.topmodel). Simulates TOPMODEL which is a physically based hydrologic model.

Usage

grass_r_topmodel(
  parameters = qgisprocess:::qgis_default_value(),
  topidxstats = qgisprocess:::qgis_default_value(),
  input = qgisprocess:::qgis_default_value(),
  timestep = qgisprocess:::qgis_default_value(),
  topidxclass = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

parameters	file - Name of TOPMODEL parameters file. Path to a file.
topidxstats	file - Name of topographic index statistics file. Path to a file.
input	file - Name of rainfall and potential evapotranspiration data file. Path to a file.
timestep	number - Time step. Generate output for this time step. 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.
topidxclass	number - Topographic index class. Generate output for this topographic index class. 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 - TOPMODEL output. Path for new file.
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..
...	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 - outputFile - TOPMODEL output

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