check.fs: Check Vector of Nonexceedance Probabilities

check.fsR Documentation

Check Vector of Nonexceedance Probabilities

Description

This function checks that a nonexceedance probability (F) is in the 0 \le F \le 1 range. It does not check that the distribution specified by parameters for F = 0 or F = 1 is valid. End point checking is left to additional internal checks within the functions implementing the distribution. The function is intended for internal use to build a flow of logic throughout the distribution functions. Users are not anticipated to need this function themselves. The check.fs function is separate because of the heavy use of the logic across a myriad of functions in lmomco.

Usage

check.fs(fs)

Arguments

fs

A vector of nonexceedance probablity values.

Value

TRUE

The nonexceedance probabilities are valid.

FALSE

The nonexceedance probabilities are invalid.

Author(s)

W.H. Asquith

See Also

quaaep4, quaaep4kapmix, quacau, quaemu, quaexp, quagam, quagep, quagev, quagld, quaglo, quagno, quagov, quagpa, quagum, quakap, quakmu, quakur, qualap, qualmrq, qualn3, quanor, quape3, quaray, quarevgum, quarice, quasla, quast3, quatexp, quawak, quawei

Examples

F <- c(0.5,0.7,0.9,1.1)
if(check.fs(F) == FALSE) cat("Bad nonexceedances 0<F<1\n")

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