GParetoParameter-class

0th

Percentile

Parameter of generalized Pareto distributions

The class of the parameter of generalized Pareto distribution.

Keywords
models, distribution
Objects from the Class

Objects can be created by calls of the form new("GParetoParameter", ...).

Slots

loc

real number: location parameter of a generalized Pareto distribution.

scale

real number: scale parameter of a generalized Pareto distribution.

shape

real number: shape parameter of a generalized Pareto distribution.

name

default name is “parameter of a GPareto distribution”.

Extends

Class "Parameter", directly. Class "OptionalParameter", by class "Parameter".

Methods

loc

signature(object = "GParetoParameter"): access method for slot loc.

location

signature(object = "GParetoParameter"): alias to loc, to support argument naming of package VGAM.

scale

signature(object = "GParetoParameter"): access method for slot scale.

shape

signature(object = "GParetoParameter"): access method for slot shape.

loc<-

signature(object = "GParetoParameter"): replace method for slot loc.

location<-

signature(object = "GParetoParameter"): alias to loc<-, to support argument naming of package VGAM.

shape<-

signature(object = "GParetoParameter"): replace method for slot shape.

shape<-

signature(object = "GParetoParameter"): replace method for slot shape.

See Also

GPareto-class, Parameter-class

Aliases
  • GParetoParameter-class
  • loc,GParetoParameter-method
  • loc<-,GParetoParameter-method
  • location,GParetoParameter-method
  • location<-,GParetoParameter-method
  • scale,GParetoParameter-method
  • scale<-,GParetoParameter-method
  • shape,GParetoParameter-method
  • shape<-,GParetoParameter-method
Examples
# NOT RUN {
P <- new("GParetoParameter")
loc(P)
## same as
location(P)
scale(P)
shape(P)

scale(P) <- 2
loc(P) <- -5
shape(P) <- -1 # may be negative
P
# }
Documentation reproduced from package RobExtremes, version 1.2.0, License: LGPL-3

Community examples

Looks like there are no examples yet.