R/wqi.R

#' wqi function.
#' 
#' Final CCME water quality index score
#'
#' @param F1
#' @param F2
#' @param F3
#' @param method optional CCAMP method.
#' 
#' @export
#' @details
#' Inputs must be numeric.
#' 
#' @seealso \url{http://www.ccme.ca/en/resources/canadian_environmental_quality_guidelines/calculators.html}
wqi <- function(F1, F2, F3, method = NULL) {
 
  assertthat::assert_that(is.numeric(F1))
  assertthat::assert_that(is.numeric(F2))
  assertthat::assert_that(is.numeric(F3))

   if(is.null(method)){
     100 - (sqrt(F1 ^ 2 + F2 ^ 2 + F3 ^ 2) / 1.732)
   } else {
     100 - (sqrt(F2 ^ 2 + F3 ^ 2) / 1.414)
   }
}
jgrew/ccmewqi documentation built on May 19, 2019, 9:26 a.m.