summary.pot: Compactly display the structure

View source: R/pot-gen-summary.R

summary.potR Documentation

Compactly display the structure

Description

Compactly display the structure of an object of class 'pot'

Usage

## S3 method for class 'pot'
summary(object, ...)

Arguments

object

An object of class 'pot'. Most often, this is an object return by the fitgpd, fitbvgpd and fitmcgpd functions.

...

Other arguments to be passed to the str function.

Value

Standard summary object: see summary.

Author(s)

Christophe Dutang

See Also

summary

Examples

set.seed(123)
x <- rgpd(500, 0, 1, -0.15)
fmle <- fitgpd(x, 0)
summary(fmle)

POT documentation built on Oct. 17, 2024, 5:06 p.m.