/
lgumbel.R
148 lines (132 loc) · 4.22 KB
/
lgumbel.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# Copyright 2023 Province of British Columbia
#
# 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_warn("1.0.0", "dlgumbel()")
ddist("gumbel",
x = x, location = locationlog, scale = scalelog,
log = log, .lgt = TRUE
)
}
#' @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")`
#' @inheritParams params
#' @export
plgumbel <- function(q, locationlog = 0, scalelog = 1, lower.tail = TRUE, log.p = FALSE) {
lifecycle::deprecate_warn("1.0.0", "plgumbel()", "ssd_plgumbel()")
ssd_plgumbel(q,
locationlog = locationlog, scalelog = scalelog,
lower.tail = lower.tail, log.p = log.p
)
}
#' @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")`
#' @inheritParams params
#' @export
qlgumbel <- function(p, locationlog = 0, scalelog = 1, lower.tail = TRUE, log.p = FALSE) {
lifecycle::deprecate_warn("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
#' `r lifecycle::badge("deprecated")`
#' @inheritParams params
#' @export
rlgumbel <- function(n, locationlog = 0, scalelog = 1) {
lifecycle::deprecate_warn("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))
}