boodist (version 1.0.0)

InverseGaussian: Inverse Gaussian distribution

Description

A R6 class to represent an inverse Gaussian distribution.

Active bindings

mu

Get or set the value of mu.

lambda

Get or set the value of lambda.

Methods

Public methods

• InverseGaussian$new()

• InverseGaussian$d()

• InverseGaussian$p()

• InverseGaussian$q()

• InverseGaussian$r()

• InverseGaussian$mean()

• InverseGaussian$median()

• InverseGaussian$mode()

• InverseGaussian$sd()

• InverseGaussian$variance()

• InverseGaussian$skewness()

• InverseGaussian$kurtosis()

• InverseGaussian$kurtosisExcess()

• InverseGaussian$clone()

---

Method new()

New inverse Gaussian distribution.

Usage

InverseGaussian$new(mu, lambda)

Arguments

mu

parameter, the mean, >0

lambda

shape parameter, >0

Returns

An inverseGaussian object.

---

Method d()

Density function of the inverse Gaussian distribution.

Usage

InverseGaussian$d(x, log = FALSE)

Arguments

x

vector of positive numbers

log

Boolean, whether to return the logarithm of the density

Returns

The density or the log-density evaluated at x.

---

Method p()

Cumulative distribution function of the inverse Gaussian distribution.

Usage

InverseGaussian$p(q, lower = TRUE)

Arguments

q

numeric vector of quantiles

lower

Boolean, whether to deal with the lower tail

Returns

The cumulative probabilities corresponding to q.

---

Method q()

Quantile function of the inverse Gaussian distribution.

Usage

InverseGaussian$q(p, lower = TRUE)

Arguments

p

numeric vector of probabilities

lower

Boolean, whether to deal with the lower tail

Returns

The quantiles corresponding to p.

---

Method r()

Sampling from the inverse Gaussian distribution.

Usage

InverseGaussian$r(n)

Arguments

n

number of simulations

Returns

A numeric vector of length n.

---

Method mean()

Mean of the inverse Gaussian distribution.

Usage

InverseGaussian$mean()

Returns

The mean of the inverse Gaussian distribution.

---

Method median()

Median of the inverse Gaussian distribution.

Usage

InverseGaussian$median()

Returns

The median of the inverse Gaussian distribution.

---

Method mode()

Mode of the inverse Gaussian distribution.

Usage

InverseGaussian$mode()

Returns

The mode of the inverse Gaussian distribution.

---

Method sd()

Standard deviation of the inverse Gaussian distribution.

Usage

InverseGaussian$sd()

Returns

The standard deviation of the inverse Gaussian distribution.

---

Method variance()

Variance of the inverse Gaussian distribution.

Usage

InverseGaussian$variance()

Returns

The variance of the inverse Gaussian distribution.

---

Method skewness()

Skewness of the inverse Gaussian distribution.

Usage

InverseGaussian$skewness()

Returns

The skewness of the inverse Gaussian distribution.

---

Method kurtosis()

Kurtosis of the inverse Gaussian distribution.

Usage

InverseGaussian$kurtosis()

Returns

The kurtosis of the inverse Gaussian distribution.

---

Method kurtosisExcess()

Kurtosis excess of the inverse Gaussian distribution.

Usage

InverseGaussian$kurtosisExcess()

Returns

The kurtosis excess of the inverse Gaussian distribution.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

InverseGaussian$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

See Wikipedia.