lodds: Logit (log-odds) and inverse-logit function.

Description Usage Arguments Details Value Examples

Description

Calculates the logit (log-odds) and inverse-logit.

Usage

1
2
3
logit(mu)

inv_logit(eta)

Arguments

mu

A numeric object with probabilies, with values in the in the range [0,1]. Missing values (NAs) are allowed.

eta

A numeric object with log-odds values, with values in the range [-Inf,Inf]. Missing values (NAs) are allowed.

Details

Values of mu equal to 0 or 1 will return -Inf or Inf respectively.

Value

A numeric object of the same type as mu and eta containing the logits or inverse logit of the input values. The logit and inverse transformation equates to

logit(μ) = log(μ/(1-μ))

logit^-1(η) = exp(η)/(1 + exp(η)).

Examples

1
2
logit(0.2)
inv_logit(-1.386)

RBesT documentation built on Nov. 24, 2021, 5:07 p.m.