R/sagang_02_carboncyclesimulationforterrestrialbiomass.R

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

##' QGIS Algorithm provided by SAGA Next Gen 02: carbon cycle simulation for terrestrial biomass (sagang:02:carboncyclesimulationforterrestrialbiomass). ---------------- Arguments ----------------  TABLE: Results 	Argument type:	vectorDestination 	Acceptable values: 		- Path for new vector layer TIME_SPAN: Time Span 	Default value:	100 	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 TIME_STEP: Time Interval (a) 	Default value:	0.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 PRIMPROD: Net Primary Production (Gt Carbon / a) 	Default value:	27.8 	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 CHUMIFY: Humification Factor 	Default value:	0.4 	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 CCARBON: Carbonization Factor 	Default value:	0.05 	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 P_LEAV: Leaves 	Default value:	0.3 	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 P_BRAN: Branches 	Default value:	0.2 	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 P_STEM: Stems 	Default value:	0.3 	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 P_ROOT: Roots 	Default value:	0.2 	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 K_LEAV_LITT: Leaves to Litter 	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 K_BRAN_LITT: Branches to Litter 	Default value:	0.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 K_STEM_LITT: Stems to Litter 	Default value:	0.033 	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 K_ROOT_HUMU: Roots to Humus 	Default value:	0.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 K_LITT_HUMU: Litter to Humus 	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 K_HUMU_COAL: Humus to Charcoal 	Default value:	0.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 K_COAL_ENVI: Charcoal to Environment 	Default value:	0.002 	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
##'
##' @title QGIS algorithm - 02: carbon cycle simulation for terrestrial biomass
##'
##' @param TABLE `vectorDestination` - Results. Path for new vector layer.
##' @param TIME_SPAN `number` - Time Span. 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.
##' @param TIME_STEP `number` - Time Interval (a). 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.
##' @param PRIMPROD `number` - Net Primary Production (Gt Carbon \code{/} a). 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.
##' @param CHUMIFY `number` - Humification Factor. 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.
##' @param CCARBON `number` - Carbonization Factor. 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.
##' @param P_LEAV `number` - Leaves. 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.
##' @param P_BRAN `number` - Branches. 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.
##' @param P_STEM `number` - Stems. 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.
##' @param P_ROOT `number` - Roots. 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.
##' @param K_LEAV_LITT `number` - Leaves to Litter. 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.
##' @param K_BRAN_LITT `number` - Branches to Litter. 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.
##' @param K_STEM_LITT `number` - Stems to Litter. 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.
##' @param K_ROOT_HUMU `number` - Roots to Humus. 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.
##' @param K_LITT_HUMU `number` - Litter to Humus. 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.
##' @param K_HUMU_COAL `number` - Humus to Charcoal. 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.
##' @param K_COAL_ENVI `number` - Charcoal to Environment. 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.
##' @param ... further parameters passed to `qgisprocess::qgis_run_algorithm()`
##' @param .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`.
##' @param .quiet logical specifying if parameter `.quiet` for `qgisprocess::qgis_run_algorithm()` Default value is `TRUE`.
##' @param .messages logical specifying if messages from `qgisprocess::qgis_run_algorithm()` should be printed (`TRUE`) or not (`FALSE`). Default value is `FALSE`.
##'
##' @details
##' ## Outputs description
##' * TABLE - outputVector - Results
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

sagang_02_carboncyclesimulationforterrestrialbiomass <- function(TABLE = qgisprocess:::qgis_default_value(), TIME_SPAN = qgisprocess:::qgis_default_value(), TIME_STEP = qgisprocess:::qgis_default_value(), PRIMPROD = qgisprocess:::qgis_default_value(), CHUMIFY = qgisprocess:::qgis_default_value(), CCARBON = qgisprocess:::qgis_default_value(), P_LEAV = qgisprocess:::qgis_default_value(), P_BRAN = qgisprocess:::qgis_default_value(), P_STEM = qgisprocess:::qgis_default_value(), P_ROOT = qgisprocess:::qgis_default_value(), K_LEAV_LITT = qgisprocess:::qgis_default_value(), K_BRAN_LITT = qgisprocess:::qgis_default_value(), K_STEM_LITT = qgisprocess:::qgis_default_value(), K_ROOT_HUMU = qgisprocess:::qgis_default_value(), K_LITT_HUMU = qgisprocess:::qgis_default_value(), K_HUMU_COAL = qgisprocess:::qgis_default_value(), K_COAL_ENVI = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {

  check_algorithm_necessities("sagang:02:carboncyclesimulationforterrestrialbiomass")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("sagang:02:carboncyclesimulationforterrestrialbiomass", `TABLE` = TABLE, `TIME_SPAN` = TIME_SPAN, `TIME_STEP` = TIME_STEP, `PRIMPROD` = PRIMPROD, `CHUMIFY` = CHUMIFY, `CCARBON` = CCARBON, `P_LEAV` = P_LEAV, `P_BRAN` = P_BRAN, `P_STEM` = P_STEM, `P_ROOT` = P_ROOT, `K_LEAV_LITT` = K_LEAV_LITT, `K_BRAN_LITT` = K_BRAN_LITT, `K_STEM_LITT` = K_STEM_LITT, `K_ROOT_HUMU` = K_ROOT_HUMU, `K_LITT_HUMU` = K_LITT_HUMU, `K_HUMU_COAL` = K_HUMU_COAL, `K_COAL_ENVI` = K_COAL_ENVI,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("sagang:02:carboncyclesimulationforterrestrialbiomass", `TABLE` = TABLE, `TIME_SPAN` = TIME_SPAN, `TIME_STEP` = TIME_STEP, `PRIMPROD` = PRIMPROD, `CHUMIFY` = CHUMIFY, `CCARBON` = CCARBON, `P_LEAV` = P_LEAV, `P_BRAN` = P_BRAN, `P_STEM` = P_STEM, `P_ROOT` = P_ROOT, `K_LEAV_LITT` = K_LEAV_LITT, `K_BRAN_LITT` = K_BRAN_LITT, `K_STEM_LITT` = K_STEM_LITT, `K_ROOT_HUMU` = K_ROOT_HUMU, `K_LITT_HUMU` = K_LITT_HUMU, `K_HUMU_COAL` = K_HUMU_COAL, `K_COAL_ENVI` = K_COAL_ENVI,..., .quiet = .quiet)
      )
  }

  if (.complete_output) {
    return(output)
  }
  else{
    qgisprocess::qgis_extract_output(output, "TABLE")
  }
}