Skip to content

Commit

Permalink
hotfix: remove function again
Browse files Browse the repository at this point in the history
it had previously been removed
  • Loading branch information
sbfnk committed Mar 15, 2024
1 parent 985f997 commit 1f4db87
Showing 1 changed file with 0 additions and 33 deletions.
33 changes: 0 additions & 33 deletions R/deprecated.R
Original file line number Diff line number Diff line change
Expand Up @@ -179,39 +179,6 @@ lognorm_dist_def <- function(mean, mean_sd,
return(dist)
}

#' Tune an Inverse Gamma to Achieve the Target Truncation
#'
#' @description `r lifecycle::badge("deprecated")`
#' Allows an inverse gamma distribution to be. tuned so that less than 0.01 of
#' its probability mass function falls outside of the specified bounds. This is
#' required when using an inverse gamma prior, for example for a Gaussian
#' process. As no inverse gamma priors are currently in use and this function
#' has some stability issues it has been deprecated.
#'
#' @param lower Numeric, defaults to 2. Lower truncation bound.
#'
#' @param upper Numeric, defaults to 21. Upper truncation bound.
#'
#' @return A list of alpha and beta values that describe a inverse gamma
#' distribution that achieves the target truncation.
#' @export
#'
#' @keywords internal
#'
tune_inv_gamma <- function(lower = 2, upper = 21) {
lifecycle::deprecate_stop(
"1.3.6", "tune_inv_gamma()",
details = paste0(
"As no inverse gamma priors are currently in use and this function has ",
"some stability issues it has been deprecated. Please let the package ",
"authors know if deprecating this function has caused any issues. ",
"For the last active version of the function see the one contained ",
"in version 1.3.5 at ",
"https://github.com/epiforecasts/EpiNow2/blob/bad836ebd650ace73ad1ead887fd0eae98c52dd6/R/dist.R#L739" # nolint
)
)
}

#' Specify a distribution.
#'
#' @description `r lifecycle::badge("deprecated")`
Expand Down

0 comments on commit 1f4db87

Please sign in to comment.