# Loglogistic: Log-Logistic Distribution Class In distr6: The Complete R6 Probability Distributions Interface

## Description

Mathematical and statistical functions for the Log-Logistic distribution, which is commonly used in survival analysis for its non-monotonic hazard as well as in economics.

## Details

The Log-Logistic distribution parameterised with shape, β, and scale, α is defined by the pdf,

f(x) = (β/α)(x/α)^{β-1}(1 + (x/α)^β)^{-2}

for α, β > 0.

## Value

Returns an R6 object inheriting from class SDistribution.

## Distribution support

The distribution is supported on the non-negative Reals.

## Default Parameterisation

LLogis(scale = 1, shape = 1)

N/A

## Also known as

Also known as the Fisk distribution.

## Super classes

`distr6::Distribution` -> `distr6::SDistribution` -> `Loglogistic`

## Public fields

`name`

Full name of distribution.

`short_name`

Short name of distribution for printing.

`description`

Brief description of the distribution.

`packages`

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

## Methods

#### Public methods

Inherited methods

#### Method `new()`

Creates a new instance of this R6 class.

##### Usage
`Loglogistic\$new(scale = NULL, shape = NULL, rate = NULL, decorators = NULL)`
##### Arguments
`scale`

`(numeric(1))`
Scale parameter, defined on the positive Reals.

`shape`

`(numeric(1))`
Shape parameter, defined on the positive Reals.

`rate`

`(numeric(1))`
Alternate scale parameter, `rate = 1/scale`. If given then `scale` is ignored.

`decorators`

`(character())`
Decorators to add to the distribution during construction.

#### Method `mean()`

The arithmetic mean of a (discrete) probability distribution X is the expectation

E_X(X) = ∑ p_X(x)*x

with an integration analogue for continuous distributions.

##### Usage
`Loglogistic\$mean(...)`
`...`

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).

##### Usage
`Loglogistic\$mode(which = "all")`
##### Arguments
`which`

`(character(1) | numeric(1)`
Ignored if distribution is unimodal. Otherwise `"all"` returns all modes, otherwise specifies which mode to return.

#### Method `median()`

Returns the median of the distribution. If an analytical expression is available returns distribution median, otherwise if symmetric returns `self\$mean`, otherwise returns `self\$quantile(0.5)`.

##### Usage
`Loglogistic\$median()`

#### 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.

##### Usage
`Loglogistic\$variance(...)`
`...`

Unused.

#### Method `skewness()`

The skewness of a distribution is defined by the third standardised moment,

sk_X = E_X[((x - μ)/σ)^3]

where E_X is the expectation of distribution X, μ is the mean of the distribution and σ is the standard deviation of the distribution.

##### Usage
`Loglogistic\$skewness(...)`
`...`

Unused.

#### Method `kurtosis()`

The kurtosis of a distribution is defined by the fourth standardised moment,

k_X = E_X[((x - μ)/σ)^4]

where E_X is the expectation of distribution X, μ is the mean of the distribution and σ is the standard deviation of the distribution. Excess Kurtosis is Kurtosis - 3.

##### Usage
`Loglogistic\$kurtosis(excess = TRUE, ...)`
##### Arguments
`excess`

`(logical(1))`
If `TRUE` (default) excess kurtosis returned.

`...`

Unused.

#### Method `pgf()`

The probability generating function is defined by

pgf_X(z) = E_X[exp(z^x)]

where X is the distribution and E_X is the expectation of the distribution X.

##### Usage
`Loglogistic\$pgf(z, ...)`
##### 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.

##### Usage
`Loglogistic\$clone(deep = FALSE)`
##### Arguments
`deep`

Whether to make a deep clone.

## 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`, `Lognormal`, `MultivariateNormal`, `Normal`, `Pareto`, `Poisson`, `Rayleigh`, `ShiftedLoglogistic`, `StudentTNoncentral`, `StudentT`, `Triangular`, `Uniform`, `Wald`, `Weibull`
Other univariate distributions: `Arcsine`, `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`, `Lognormal`, `NegativeBinomial`, `Normal`, `Pareto`, `Poisson`, `Rayleigh`, `ShiftedLoglogistic`, `StudentTNoncentral`, `StudentT`, `Triangular`, `Uniform`, `Wald`, `Weibull`, `WeightedDiscrete`
{"ft_lang_label":"__label__en","ft_lang_prob":0.73651534,"math_prob":0.93386644,"size":4690,"snap":"2021-31-2021-39","text_gpt3_token_len":1232,"char_repetition_ratio":0.17456253,"word_repetition_ratio":0.18222222,"special_character_ratio":0.23219617,"punctuation_ratio":0.21489622,"nsfw_num_words":0,"has_unicode_error":false,"math_prob_llama3":0.99864286,"pos_list":[0],"im_url_duplicate_count":[null],"WARC_HEADER":"{\"WARC-Type\":\"response\",\"WARC-Date\":\"2021-09-27T23:28:57Z\",\"WARC-Record-ID\":\"<urn:uuid:e4ae1d37-f880-4a0c-ada7-3504a6a4baf8>\",\"Content-Length\":\"59641\",\"Content-Type\":\"application/http; msgtype=response\",\"WARC-Warcinfo-ID\":\"<urn:uuid:39367ddd-d6ec-401b-aab2-2d26b71ff62b>\",\"WARC-Concurrent-To\":\"<urn:uuid:36f60b01-5728-40f5-87fd-57404a694f8e>\",\"WARC-IP-Address\":\"51.81.83.12\",\"WARC-Target-URI\":\"https://rdrr.io/cran/distr6/man/Loglogistic.html\",\"WARC-Payload-Digest\":\"sha1:4OKSUTZWLM56G5XVZEBL64KRLWPP46XJ\",\"WARC-Block-Digest\":\"sha1:D7LOVKSFXKOQ5GHTIXWDZVKLIPGLSAFX\",\"WARC-Identified-Payload-Type\":\"text/html\",\"warc_filename\":\"/cc_download/warc_2021/CC-MAIN-2021-39/CC-MAIN-2021-39_segments_1631780058552.54_warc_CC-MAIN-20210927211955-20210928001955-00105.warc.gz\"}"}