SSTd-class {distrRmetrics}R Documentation

SSTd distribution

Description

The standardized skew Student-t distribution.

Objects from the Class

Objects can be created by calls of the form new("SSTd", mean, sd,xi). More frequently they are created via the generating function SSTd.

Slots

img

Object of class "Reals".

param

Object of class "SSTdParameter".

r

rgpd

d

dgpd

p

pgpd, but vectorized and with special treatment of arguments lower.tail and log.p

q

qgpd, but vectorized and with special treatment of arguments lower.tail and log.p

gaps

(numeric) matrix or NULL

.withArith

logical: used internally to issue warnings as to interpretation of arithmetics

.withSim

logical: used internally to issue warnings as to accuracy

.logExact

logical: used internally to flag the case where there are explicit formulae for the log version of density, cdf, and quantile function

.lowerExact

logical: used internally to flag the case where there are explicit formulae for the lower tail version of cdf and quantile function

Extends

Class "AbscontDistribution", directly.
Class "UnivariateDistribution", by class "AbscontDistribution".
Class "Distribution", by class "AbscontDistribution".

Methods

xi

signature(object = "SSTd"): wrapped access method for slot xi of slot param.

mean

signature(object = "SSTd"): wrapped access method for slot mean of slot param.

nu

signature(object = "SSTd"): wrapped access method for slot nu of slot param.

sd

signature(x = "SSTd"): wrapped access method for slot sd of slot param.

xi<-

signature(object = "SSTd"): wrapped replace method for slot xi of slot param.

mean<-

signature(object = "SSTd"): wrapped replace method for slot mean of slot param.

nu<-

signature(object = "SSTd"): wrapped replace method for slot nu of slot param.

sd<-

signature(x = "SSTd"): wrapped replace method for slot sd of slot param.

Note

This class is based on the code provided by the package fGarch by Diethelm Wuertz

Author(s)

Peter Ruckdeschel peter.ruckdeschel@uni-oldenburg.de

See Also

dsstd, AbscontDistribution-class

Examples

(ST <- SSTd(xi=2, nu = 3)) # ST is a skewed t distribution with xi = 2 and nu = 3.
set.seed(1)
r(ST)(1) # one random number generated from this distribution, e.g. -0.4432824
d(ST)(1) # Density of this distribution is 0.1204624 for x = 1.
p(ST)(1) # Probability that x < 1 is 0.9035449.
q(ST)(.1) # Probability that x < -0.4432824 is 0.1.
## in RStudio or Jupyter IRKernel, use q.l(.)(.) instead of q(.)(.)
nu(ST) # df of this distribution is 3.
nu(ST) <- 4 # df of this distribution is now 4.
plot(ST)

[Package distrRmetrics version 2.8.2 Index]