invprobit: Inverse probit function

View source: R/stats_functions.R

invprobitR Documentation

Inverse probit function

Description

Calculate the values of the sigmoidal function that is defined by the cumulative normal distribution function (pnorm). This method provides a convenient wrapper for the pnorm that automatically handles negative zeta and is more consistent in its naming.

Usage

invprobit(x, rho, zeta, log = FALSE, oneminus = FALSE)

Arguments

x

numeric vector

rho

numeric vector of length 1 or the same length as x. Specifies the inflection point of the inverse probit curve.

zeta

numeric vector of length 1 or the same length as x. Specifies the scale of the curve at the inflection point of the inverse probit curve.

log

boolean if the log of the result is returned

oneminus

boolean if one minus the result is returned

Value

a numeric vector of length(x).

Examples

 xg <- seq(-5, 5, length.out=101)
 plot(xg, invprobit(xg, rho=-2, zeta=-0.3))

const-ae/proDA documentation built on Oct. 31, 2023, 9:39 p.m.