R/droughtclass.R

In mammask/droughtR: Reduced Bias Drought Forecasting Framework

#' droughtclass
#'
#' Assigns classes to various ranges of the standardized precipitation index (SPI)
#'
#' @param x A numeric value indicating the characterization of drought.
#'
#' @return numeric
#' @export
#'
#' @examples droughtclass(1.5)
droughtclass = function(x){

  if (is.na(x)){

    type = as.character(NA)

  } else if (round(x,1) >= 2){

    type = "Extremely Wet"

  } else if (round(x,1) >= 1.5 & round(x,1) <= 1.99){

    type = "Very Wet"

  } else if (round(x,1) >= 1.0 & round(x,1) <= 1.49){

    type = "Moderately Wet"

  } else if (round(x,1) >= -0.99 & round(x,1) <= 0.99){

    type = "Near Normal"

  } else if (round(x,1) >= -1.49 &  round(x,1) <= -1.0){

    type = "Moderately Dry"

  } else if (round(x,1) >= -1.99 & round(x,1) <= -1.5){

    type = "Very Dry"

  } else if (round(x,1) <= -2){

    type = "Extremely Dry"

  }

  return(type)
}