f2f: Subsetting of Nonexceedance Probabilities Related to...

In lmomco: L-Moments, Censored L-Moments, Trimmed L-Moments, L-Comoments, and Many Distributions

Subsetting of Nonexceedance Probabilities Related to Conditional Probability Adjustment

Description

This function subsetting nonexceedance probability according to

F(x) <- F(x | F(x) [>,\ge] p)\mathrm{,}

where F is nonexceedance probability for x and pp is the probability of a threshold. In R logic, this is simply f <- f[f > pp] for type == "gt" or f <- f[f >= pp] for type == "ge".

This function is particularly useful to shorten a commonly needed code logic related such as FF[FF >= XloALL$pp], which would be needed in conditional probability adjustements and XloALL is from x2xlo. This could be replaced by syntax such as f2f(FF, xlo=XloALL). This function is very similar to f2flo with the only exception that the conditional probability adjustment is not made.

Usage

f2f(f, pp=NA, xlo=NULL, type=c("ge", "gt"))

Arguments

f	A vector of nonexceedance probabilities.
pp	The plotting position of the left-hand threshold and recommended to come from x2xlo.
xlo	An optional result from x2xlo from which the pp will be take instead of from the argument pp.
type	The type of the logical construction gt means greater than the pp and ge means greater than or equal to the pp for the computations. There can be subtle variations in conceptualization of the truncation need or purpose and hence this argument is provided for flexibility.

Value

A vector of conditional nonexceedance probabilities.

Author(s)

W.H. Asquith

See Also

x2xlo, xlo2qua, f2flo, f2f

Examples

# See examples for x2xlo().

lmomco documentation built on May 29, 2024, 10:06 a.m.