summary.evpost: Summarizing an evpost object

In paulnorthrop/revdbayes: Ratio-of-Uniforms Sampling for Bayesian Extreme Value Analysis

Summarizing an evpost object

Description

summary method for class "evpost"

Usage

## S3 method for class 'evpost'
summary(object, add_pu = FALSE, ...)

Arguments

object	An object of class "evpost", a result of a call to rpost or rpost_rcpp.
add_pu	Includes in the summary of the simulated values the threshold exceedance probability p. Only relevant when model == "bingp" was used in the call to rpost or rpost_rcpp.
...	Additional arguments passed on to print.

Value

Prints

• information about the ratio-of-uniforms bounding box, i.e. object$box

• an estimate of the probability of acceptance, i.e. object$pa

• a summary of the simulated values, via summary(object$sim_vals)

See Also

ru or ru_rcpp for descriptions of object$sim_vals and object$box.

plot.evpost for a diagnostic plot.

Examples

# GP posterior
u <- stats::quantile(gom, probs = 0.65)
fp <- set_prior(prior = "flat", model = "gp", min_xi = -1)
gpg <- rpost_rcpp(n = 1000, model = "gp", prior = fp, thresh = u,
                  data = gom)
summary(gpg)

paulnorthrop/revdbayes documentation built on Aug. 22, 2024, 1:35 a.m.