R/Log_Gumbel_Formula.R

In CalcThemAll.PRM: Calculate Pesticide Risk Metric (PRM) Values from Multiple Pesticides...Calc Them All

#' Log Gumbel CDF Equation Formula
#'
#' @param concentration The vector of concentration values for a selected pesticide,
#' that has a Log Gumbel shaped species sensitivity distribution,
#' to run the equation on.
#' @param shape_location The mu/location value for the Log Gumbel equation for the selected pesticide.
#' These can be found in the "pesticide_info" data frame provided in this package.
#' If you are including other pesticides you will need to append them with their
#' respective distribution variables to the "pesticide_info" table.
#' @param scale The beta/scale value for the Log Gumbel equation for the selected pesticide.
#' These can be found in the "pesticide_info" data frame provided in this package.
#' If you are including other pesticides you will need to append them with their
#' respective distribution variables to the "pesticide_info" table.

#'
#' @return a numeric vector
#' @export
#'
#' @examples
#' #This Example should produce roughly 1% and 5% PRM values
#' LogGumbel_pesticide_concentrations <- c(0.095957794, 0.245881898)
#' Log_Gumbel_Formula(concentration = LogGumbel_pesticide_concentrations,
#' shape_location = 0.9980581, scale = 2.188285)


# Compute the Gamma CDF for the given concentration to find PRM
Log_Gumbel_Formula <- function(concentration, shape_location, scale){
  concentration <- as.numeric(concentration)
  PRM <- 100*VGAM::pgumbel(q = log(concentration), location = shape_location, scale = scale)
  PRM
}