plot.choose_uk {exdex} | R Documentation |
Plot threshold u
and runs parameter K
diagnostic for the
K
-gaps estimator
Description
plot
method for objects inheriting from class "choose_uk"
,
returned from choose_uk
Usage
## S3 method for class 'choose_uk'
plot(
x,
y = c("imts", "theta"),
level = 0.95,
interval_type = c("norm", "lik"),
conf_scale = c("theta", "log"),
alpha = 0.05,
constrain = TRUE,
for_abline = list(lty = 2, lwd = 1, col = 1),
digits = 3,
uprob = FALSE,
leg_pos = if (y == "imts") "topright" else "topleft",
...
)
Arguments
x |
an object of class |
y |
A character scalar indicating what should be plotted on the
vertical axes of the plot: information matrix test statistics (IMTS)
if |
level |
A numeric scalar in (0, 1). The confidence level used in
calculating confidence intervals for |
interval_type |
A character scalar. The type of confidence interval
to be plotted, if |
conf_scale |
A character scalar. If |
alpha |
A numeric vector with entries in (0, 1). The size of the test to be performed. |
constrain |
A logical scalar. The argument |
for_abline |
Only relevant when |
digits |
An integer. Used for formatting the value of the threshold
with |
uprob |
A logical scalar. Should we plot |
leg_pos |
A character scalar. The position of any legend added to
a plot. Only relevant when both the arguments |
... |
Additional arguments passed to |
Details
The type of plot produced depends mainly on y
.
If y = "imts"
then the values of IMTS are plotted against the
thresholds in x$u
(or their corresponding approximate sample
quantile levels if uprob = TRUE
) for each value of K
in x$k
. Horizontal lines are added to indicate the critical
values of the IMT for the significance levels in alpha
.
We would not reject at the 100alpha
% level combinations of
threshold and K
corresponding to values of the IMTS that fall
below the line.
If y = "theta"
then estimates of \theta
are plotted on the
vertical axis. If both x$u
and x$k$
have length greater
than one then only these estimates are plotted. If either x$u
or x$k
have length one then approximate 100level
%
confidence intervals are added to the plot and the variable,
x$u
or x$k
that has length greater than one is plotted on
the horizontal axis.
Value
Nothing is returned.
Examples
See the examples in choose_uk
.