Learn R Programming

lmomco (version 2.4.14)

xlo2qua: Conversion of a Vector through a Left-Hand Threshold to Setup Conditional Probability Computations

Description

This function takes a vector of nonexceedance probabilities, a parameter object, and the object of the conditional probabability structure and computes the quantiles. This function only performs very simple vector operations. The real features for conditional probability application are found in the x2xlo and f2flo functions.

Usage

xlo2qua(f, para=NULL, xlo=NULL, augasNA=FALSE, sort=FALSE, fillthres=TRUE,
           retrans=function(x) x, paracheck=TRUE, ...)

Value

A vector of quantiles (sorted) for the nonexceedance probabilities and padding as needed to the threshold within the xlo object.

Arguments

f

Nonexceedance probability (\(0 \le F \le 1\)). Be aware, these are sorted internally.

para

Parameters from parpe3 or vec2par.

xlo

Mandatory result from x2xlo containing the content needed for internal call to f2flo and then vector augmentation with the threshold within the xlo. If this is left as NULL, then the function simply calls the quantile function for the parameters in para.

augasNA

A logical to switch out the threshold of xlo for NA.

sort

A logical whose default adheres to long-term assembly of lmomco behavior with working with conditional trunction. Setting this to true, triggers hand assembly of the the unsorted returned quantiles with support for NA and more flexibility than x2xlo as originally designed. If sort is true, then the f is permitted to contain NA values.

fillthres

A logical to trigger qua[qua <= xlo$thres] <- xlo$thres or replacement of computed values less than the threshold with the threshold. The argument augasNA is consulted after fillthres.

retrans

A retransformation function for the quantiles after they are computed according to the para.

paracheck

A logical controlling whether the parameters are checked for validity.

...

Additional arguments, if needed, dispatched to par2qua.

Author

W.H. Asquith

See Also

f2flo, flo2f, f2f, x2xlo