getDistanceProbability {windAC}

Calculate probabilities within one unit increments.

Description

Probabilities are calculated between specified increments for a given distribution and parameter values.

Usage

getDistanceProbability(
  q,
  distribution,
  param1,
  param2 = NA,
  tbound = c(-Inf, Inf),
  unitSize = 1,
  ...
)

Arguments

q

Vector of quantiles.

distribution

Character value; specifying the desired probability distribution, see ptrunc.

param1

Numeric; value of the first parameter of the specified distribution.

param2

Numeric; default is NA. Value of the second parameter of the specified distribution, if applicable.

tbound

Numeric vector specifying the lower and upper truncation bounds. Default is c(-Inf, Inf).

unitSize

Numeric; either of length one or equal to length(q), specific the desired width for the probability calculation. Default is 1.

...

Currently ignored.

Details

This is a wrapper function that uses the ptrunc function. The basic calculation is ptrunc(q,...) - ptrunc(q-abs(unitSize),...)

Value

Vector of probabilities

See Also

ptrunc

Examples

## normal distribution
getDistanceProbability(q=8,distribution='norm',param1=10,param2=1)
pnorm(8,mean=10,sd=1)-pnorm(8-1,mean=10,sd=1)

## larger unitSize
getDistanceProbability(q=12,distribution='norm',param1=10,param2=1,unitSize=4)
pnorm(12,mean=10,sd=1)-pnorm(12-4,mean=10,sd=1)