R/tglo.R

In LMoFit: Advanced L-Moment Fitting of Distributions

#' Return period function of Generalized Logistic distribution
#'
#' @param x quantile/s
#' @param para parameters as c(location, scale, shape)
#'
#' @return Return Period/s corresponding to quantile/s.
#' @author Mohanad Zaghloul [aut, cre], Simon Michael Papalexiou [aut, ths], Amin Elshorbagy [aut, ths]
#' @export
#' @importFrom lmom cdfglo
#'
#' @examples
#' 
#' RP <- tglo(x = 0.1, para = c(10, 0.1, 0.2))
#' 
tglo <- function(x , para = c(10, 1.5, 1)){
  u <- cdfglo(x , para)
  RP <- 1/(1 - u)
  return(RP)
}