Mathematical and statistical functions for the Log-Normal distribution, which is commonly used to model many natural phenomena as a result of growth driven by small percentage changes.

## Value

Returns an R6 object inheriting from class SDistribution.

## Details

The Log-Normal distribution parameterised with logmean, $$\mu$$, and logvar, $$\sigma$$, is defined by the pdf, $$exp(-(log(x)-\mu)^2/2\sigma^2)/(x\sigma\sqrt(2\pi))$$ for $$\mu \epsilon R$$ and $$\sigma > 0$$.

## Distribution support

The distribution is supported on the Positive Reals.

## Default Parameterisation

Lnorm(meanlog = 0, varlog = 1)

N/A

## Also known as

Also known as the Log-Gaussian distribution.

## References

McLaughlin, M. P. (2001). A compendium of common probability distributions (pp. 2014-01). Michael P. McLaughlin.

Other continuous distributions: Arcsine, BetaNoncentral, Beta, Cauchy, ChiSquaredNoncentral, ChiSquared, Dirichlet, Erlang, Exponential, FDistributionNoncentral, FDistribution, Frechet, Gamma, Gompertz, Gumbel, InverseGamma, Laplace, Logistic, Loglogistic, MultivariateNormal, Normal, Pareto, Poisson, Rayleigh, ShiftedLoglogistic, StudentTNoncentral, StudentT, Triangular, Uniform, Wald, Weibull

Other univariate distributions: Arcsine, Arrdist, Bernoulli, BetaNoncentral, Beta, Binomial, Categorical, Cauchy, ChiSquaredNoncentral, ChiSquared, Degenerate, DiscreteUniform, Empirical, Erlang, Exponential, FDistributionNoncentral, FDistribution, Frechet, Gamma, Geometric, Gompertz, Gumbel, Hypergeometric, InverseGamma, Laplace, Logarithmic, Logistic, Loglogistic, Matdist, NegativeBinomial, Normal, Pareto, Poisson, Rayleigh, ShiftedLoglogistic, StudentTNoncentral, StudentT, Triangular, Uniform, Wald, Weibull, WeightedDiscrete

## Super classes

distr6::Distribution -> distr6::SDistribution -> Lognormal

## Public fields

name

Full name of distribution.

short_name

Short name of distribution for printing.

description

Brief description of the distribution.

alias

Alias of the distribution.

packages

Packages required to be installed in order to construct the distribution.

## Methods

Inherited methods

### Method new()

Creates a new instance of this R6 class.

#### Arguments

...

Unused.

### Method mode()

The mode of a probability distribution is the point at which the pdf is a local maximum, a distribution can be unimodal (one maximum) or multimodal (several maxima).

### Method variance()

The variance of a distribution is defined by the formula $$var_X = E[X^2] - E[X]^2$$ where $$E_X$$ is the expectation of distribution X. If the distribution is multivariate the covariance matrix is returned.

#### Arguments

...

Unused.

### Method kurtosis()

The kurtosis of a distribution is defined by the fourth standardised moment, $$k_X = E_X[\frac{x - \mu}{\sigma}^4]$$ where $$E_X$$ is the expectation of distribution X, $$\mu$$ is the mean of the distribution and $$\sigma$$ is the standard deviation of the distribution. Excess Kurtosis is Kurtosis - 3.

#### Arguments

base

(integer(1))
Base of the entropy logarithm, default = 2 (Shannon entropy)

...

Unused.

### Method mgf()

The moment generating function is defined by $$mgf_X(t) = E_X[exp(xt)]$$ where X is the distribution and $$E_X$$ is the expectation of the distribution X.

#### Arguments

z

(integer(1))
z integer to evaluate probability generating function at.

...

Unused.

### Method clone()

The objects of this class are cloneable with this method.

Lognormal$clone(deep = FALSE) #### Arguments deep Whether to make a deep clone. ## Examples  ## ------------------------------------------------ ## Method Lognormal$new
## ------------------------------------------------

Lognormal$new(var = 2, mean = 1) #> Lnorm(mean = 1, var = 2) Lognormal$new(meanlog = 2, preclog = 5)
#> Lnorm(meanlog = 2, preclog = 5)