R/grass_r_topmodel_topidxstats.R
grass_r_topmodel_topidxstats.Rd
QGIS Algorithm provided by GRASS r.topmodel.topidxstats (grass:r.topmodel.topidxstats). r.topmodel.topidxstats - Builds a TOPMODEL topographic index statistics file.
grass_r_topmodel_topidxstats(
topidx = qgisprocess:::qgis_default_value(),
ntopidxclasses = qgisprocess:::qgis_default_value(),
outtopidxstats = qgisprocess:::qgis_default_value(),
GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
raster
- Name of input topographic index raster map. Path to a raster layer.
number
- Number of topographic index classes. 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.
fileDestination
- TOPMODEL topographic index statistics file. Path for new file.
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..
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.
further parameters passed to qgisprocess::qgis_run_algorithm()
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
.
logical specifying if parameter .quiet
for qgisprocess::qgis_run_algorithm()
Default value is TRUE
.
logical specifying if messages from qgisprocess::qgis_run_algorithm()
should be printed (TRUE
) or not (FALSE
). Default value is FALSE
.