R/lgumbel.R

In ssdtools: Species Sensitivity Distributions

# Copyright 2015-2023 Province of British Columbia
# Copyright 2021 Environment and Climate Change Canada
# Copyright 2023-2024 Australian Government Department of Climate Change,
# Energy, the Environment and Water
#
#    Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#
#       https://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.

#' Log-Gumbel (Inverse Weibull) Probability Density
#' `r lifecycle::badge("deprecated")`
#'
#' @param x A numeric vector of values.
#' @inheritParams params
#' @return A numeric vector.
#' @export
dlgumbel <- function(x, locationlog = 0, scalelog = 1, log = FALSE) {
  lifecycle::deprecate_stop("1.0.0", "dlgumbel()")
}

#' @describeIn ssd_p Cumulative Distribution Function for Log-Gumbel Distribution
#' @export
#' @examples
#'
#' ssd_plgumbel(1)
ssd_plgumbel <- function(q, locationlog = 0, scalelog = 1, lower.tail = TRUE, log.p = FALSE) {
  pdist("gumbel",
    q = q, location = locationlog, scale = scalelog,
    lower.tail = lower.tail, log.p = log.p, .lgt = TRUE
  )
}

#' @describeIn ssd_e Default Parameter Values for Log-Gumbel Distribution
#' @export
#' @examples
#'
#' ssd_einvpareto()
ssd_elgumbel <- function() {
  list(locationlog = 0, scalelog = 1)
}

#' Cumulative Distribution Function for Log-Gumbel Distribution
#' `r lifecycle::badge("deprecated")`
#'
#' Deprecated for `ssd_plgumbel()`.
#'
#' @inheritParams params
#' @export
plgumbel <- function(q, locationlog = 0, scalelog = 1, lower.tail = TRUE, log.p = FALSE) {
  lifecycle::deprecate_stop("1.0.0", "plgumbel()", "ssd_plgumbel()")
}

#' @describeIn ssd_q Quantile Function for Log-Gumbel Distribution
#' @export
#' @examples
#'
#' ssd_qlgumbel(0.5)
ssd_qlgumbel <- function(p, locationlog = 0, scalelog = 1, lower.tail = TRUE, log.p = FALSE) {
  qdist("gumbel",
    p = p, location = locationlog, scale = scalelog,
    lower.tail = lower.tail, log.p = log.p, .lgt = TRUE
  )
}

#' Quantile Function for Log-Gumbel Distribution
#' `r lifecycle::badge("deprecated")`
#'
#' Deprecated for `ssd_qlgumbel()`.
#'
#' @inheritParams params
#' @export
qlgumbel <- function(p, locationlog = 0, scalelog = 1, lower.tail = TRUE, log.p = FALSE) {
  lifecycle::deprecate_stop("1.0.0", "qlgumbel()", "ssd_qlgumbel()")
  ssd_qlgumbel(p,
    locationlog = locationlog, scalelog = scalelog,
    lower.tail = lower.tail, log.p = log.p
  )
}

#' @describeIn ssd_r Random Generation for log-Gumbel Distribution
#' @export
#' @examples
#'
#' set.seed(50)
#' hist(ssd_rlgumbel(10000), breaks = 1000)
ssd_rlgumbel <- function(n, locationlog = 0, scalelog = 1, chk = TRUE) {
  rdist("gumbel", n = n, location = locationlog, scale = scalelog, .lgt = TRUE, chk = chk)
}

#' @describeIn ssd_e Default Parameter Values for log-Gumbel Distribution
#' @export
#' @examples
#'
#' ssd_elgumbel()
ssd_elgumbel <- function() {
  list(locationlog = 0, scalelog = 1)
}

#' Random Generation for log-Gumbel Distribution
#'
#' Deprecated for `ssd_rlgumbel()`.
#'
#' `r lifecycle::badge("deprecated")`
#' @inheritParams params
#' @export
rlgumbel <- function(n, locationlog = 0, scalelog = 1) {
  lifecycle::deprecate_stop("1.0.0", "rlgumbel()", "ssd_rlgumbel()")
  ssd_rlgumbel(n, locationlog = locationlog, scalelog = scalelog)
}

slgumbel <- function(data, pars = NULL) {
  if (!is.null(pars)) {
    return(pars)
  }

  x <- mean_weighted_values(data)

  list(
    locationlog = mean(log(x), na.rm = TRUE),
    log_scalelog = log(pi * sd(log(x), na.rm = TRUE) / sqrt(6))
  )
}

pgumbel_ssd <- function(q, location, scale) {
  if (scale <= 0) {
    return(NaN)
  }
  exp(-exp(-(q - location) / scale))
}

qgumbel_ssd <- function(p, location, scale) {
  if (scale <= 0) {
    return(NaN)
  }
  location - scale * log(-log(p))
}

plgumbel_ssd <- function(q, locationlog, scalelog) {
  pgumbel_ssd(log(q), location = locationlog, scale = scalelog)
}

qlgumbel_ssd <- function(p, locationlog, scalelog) {
  exp(qgumbel_ssd(p, location = locationlog, scale = scalelog))
}