vec2lmom: Convert a Vector of L-moments to a L-moment Object

Description Usage Arguments Value Author(s) See Also Examples

Description

This function converts a vector of L-moments to a L-moment object of lmomco. The object is an R list. This function is intended to facilitate the use of L-moments (and TL-moments) that the user might have from other sources. L-moments and L-moment ratios of arbitrary length are supported.

Because in typical practice, the k ≥ 3 order L-moments are dimensionless ratios (τ_3, τ_4, and τ_5), this function computes λ_3, λ_4, λ_5 from λ_2 from the ratios. However, typical practice is not set on the use of λ_2 or τ as measure of dispersion. Therefore, this function takes an lscale optional logical (TRUE|FALSE) argument—if λ_2 is provided and lscale=TRUE, then τ is computed by the function and if τ is provided, then λ_2 is computed by the function.

Usage

1
2
vec2lmom(vec, lscale=TRUE,
         trim=NULL, leftrim=NULL, rightrim=NULL, checklmom=TRUE)

Arguments

vec

A vector of L-moment values in λ_1, λ_2 or τ, τ_3, τ_4, and τ_5 order.

lscale

A logical switch on the type of the second value of first argument. L-scale (λ_2) or LCV (τ). Default is TRUE, the second value in the first argument is λ_2.

trim

Level of symmetrical trimming, which should equal NULL if asymmetrical trimming is used.

leftrim

Level of trimming of the left-tail of the sample, which will equal NULL even if trim = 1 if the trimming is symmetrical.

rightrim

Level of trimming of the right-tail of the sample, which will equal NULL even if trim = 1 if the trimming is symmetrical.

checklmom

Should the lmom be checked for validity using the are.lmom.valid function. Normally this should be left as the default unless TL-moments are being constructed in lieu of using vec2TLmom.

Value

An R list is returned.

Author(s)

W.H. Asquith

See Also

lmoms, vec2pwm

Examples

1
lmr <- vec2lmom(c(12,0.6,0.34,0.20,0.05),lscale=FALSE)

lmomco documentation built on Nov. 17, 2017, 7:25 a.m.