R/check_format_interception_parameters.R

In EcoFoG/SWBM: REW computation for Paracou with the Soil Water Balance Model (Wagner et al 2011).

#'Check and format interception parameters for use in the Soil Water Balance
#'model
#'
#'This function is initially meant for internal use.
#'
#'@param ... Either several scalars corresponding to the parameters meant to
#'  replace default values in the model, or a single argument containing these
#'  parameters in a grouped form (either list or single row data.frame). See
#'  details for information on nomenclature and parameters.
#'
#'@details The parameters are inputed either separately or groupedly.
#'
#'  If inputed separately, each argument must have a name that corresponds to
#'  one of the Interception model's parameters. If the parameters are grouped
#'  into a list or a data.frame, the names of the columns/elements must also
#'  fulfill this requirement. Also note that if any parameter is missing, its
#'  corresponding default value will be used. Finally, if any argument/element
#'  has a name that does not correspond to any of the hereafter listed
#'  parameters, said argument will be ignored.
#'
#'  Here are the detailed parameters for Gash's analytical interception model:
#'
#'  * S: Canopy storage capacity per unit area
#'  * E_m: mean evaporation rate from saturated rainfall
#'
#'
#'
#'@return
#'@export
#'
#' @examples
check_format_interception_parameters <- function(...){

  # Extract the ellipsis and set the default values of the interception parameters
  .dots <- list(...)
  St <-1.5
  E_mt <- 0.64
  R_mt <- 8.98
  p_tt <-0.036
  cct <- 0.99

  # Test the input type (isolated scalars, data.frame, list)


  if(length(.dots) == 0){
    # print(names(.dots))
    message("returning default understorey parameters since nothing has been given as an input...")
    return(list(S = St,E_m = E_mt,R_m = R_mt,p_t = p_tt,cc = cct))
  }
  if(length(.dots) == 1){
    dot <- .dots[[1]]
    if(is.data.frame(dot)){
      .dots <- as.list.data.frame(dot)
    }
    else if(is.list(dot)){
      .dots <- dot
    }
  }

  for(n in names(.dots)){

    temp <- .dots[[n]]

    if(is.data.frame(temp | is.list(temp))){
      stop("You must input either scalars corresponding to the parameters you want to modifie, OR a stacked form (either a correctly named list, or a data.frame with a single row), but NOT a mix of both.")
    }
    if(!length(temp) == 1)
      stop("Please provide only one value per parameter")

    switch(n,
           "S" = {
             if(!is.numeric(temp)) stop("S must be numeric")
             if(temp<0) stop("negative values are not allowed for S")
             St <- temp
           },
           "E_m" = {
             if(!is.numeric(temp)) stop("E_m must be numeric")
             if(temp<0) stop("negative values are not allowed for E_m")
             E_mt <- temp
           },
           "R_m" = {
             if(!is.numeric(temp)) stop("R_m must be numeric")
             if(temp<0) stop("negative values are not allowed for R_m")
             R_mt <- temp
           },
           "p_t" = {
             if(!is.numeric(temp)) stop("p_t must be numeric")
             if(temp<0 | temp>1) stop("p_t (proportion of rain diverted to the trunk) must be in [0;1]")
             p_tt <- temp
           },
           "cc" = {
             if(!is.numeric(temp)) stop("cc must be numeric")
             if(temp<0 | temp>1) stop("cc (canopy cover proportion) must be in [0;1]")
             cct <- temp
           },
           message(paste0(n," is not the name of any of the model parameters. It has been ignored."))
    )
  }

  return(list(S = St,E_m = E_mt,R_m = R_mt,p_t = p_tt,cc = cct))
}