distr6 (version 1.3.6)

Logarithmic: Logarithmic Distribution Class

Description

Mathematical and statistical functions for the Logarithmic distribution, which is commonly used to model consumer purchase habits in economics and is derived from the Maclaurin series expansion of \(-ln(1-p)\).

Value

Returns an R6 object inheriting from class SDistribution.

Constructor

Logarithmic$new(theta = 0.5, decorators = NULL, verbose = FALSE)

Constructor Arguments

Argument	Type	Details
theta	numeric	theta parameter.

decorators Decorator decorators to add functionality. See details.

Constructor Details

The Logarithmic distribution is parameterised with theta as a number between 0 and 1.

Public Variables

Variable	Return
name	Name of distribution.
short_name	Id of distribution.
description	Brief description of distribution.

Public Methods

Accessor Methods	Link
decorators	decorators
traits	traits
valueSupport	valueSupport
variateForm	variateForm
type	type
properties	properties
support	support
symmetry	symmetry
sup	sup
inf	inf
dmax	dmax
dmin	dmin
skewnessType	skewnessType
kurtosisType	kurtosisType

Statistical Methods Link pdf(x1, ..., log = FALSE, simplify = TRUE) pdf cdf(x1, ..., lower.tail = TRUE, log.p = FALSE, simplify = TRUE) cdf quantile(p, ..., lower.tail = TRUE, log.p = FALSE, simplify = TRUE) quantile.Distribution rand(n, simplify = TRUE) rand mean() mean.Distribution variance() variance stdev() stdev prec() prec cor() cor skewness() skewness kurtosis(excess = TRUE) kurtosis entropy(base = 2) entropy mgf(t) mgf cf(t) cf pgf(z) pgf median() median.Distribution iqr() iqr mode(which = "all") mode

Parameter Methods Link parameters(id) parameters getParameterValue(id, error = "warn") getParameterValue setParameterValue(..., lst = NULL, error = "warn") setParameterValue

Validation Methods Link liesInSupport(x, all = TRUE, bound = FALSE) liesInSupport liesInType(x, all = TRUE, bound = FALSE) liesInType

Representation Methods Link strprint(n = 2) strprint print(n = 2) print summary(full = T) summary.Distribution

Details

The Logarithmic distribution parameterised with a parameter, \(\theta\), is defined by the pmf, $$f(x) = -\theta^x/xlog(1-\theta)$$ for \(0 < \theta < 1\).

The distribution is supported on \({1,2,3,\ldots}\).

entropy is omitted as no closed form analytic expression could be found, decorate with CoreStatistics for numerical results.

The distribution is implemented by interfacing the extraDistr package.

References

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

See Also

listDistributions for all available distributions. LogSeries for the d/p/q/r implementation. CoreStatistics for numerical results.

Examples

# NOT RUN {
x = Logarithmic$new(theta = 0.2)

# Update parameters
x$setParameterValue(theta = 0.3)
x$parameters()

# d/p/q/r
x$pdf(5)
x$cdf(5)
x$quantile(0.42)
x$rand(4)

# Statistics
x$mean()
x$variance()

summary(x)

# }