lmorph {lmomco}R Documentation

Morph an L-moment Object

Description

Morph or change one L-moment object type into another. The first L-moment object created for lmomco used an R list with named L-moment values such as L1 or TAU3. This object was bounded for L-moment orders less than or equal to five. However, subsequent package development in early 2006 that was related to the trimmed L-moments suggested that an alternative L-moment object structure be used that utilized two vectors for the L-moments and the L-moment ratios. This second object type is not bounded by L-moment order. In turn it became important to seemlessly morph from one object structure to the other and back again. The canonical structure of the first L-moment object type is documented under lmom.ub; whereas, the canonical structure for the second L-moment object type is documented under lmoms (actually, TLmoms). Because the first L-moment object is bounded by five, L-moment order larger than this will be ignored in the morphing process.

Usage

lmorph(lmom)

Arguments

lmom An L-moment object of type like lmom.ub or lmoms.

Value

A two different R lists (L-moment objects), which are the opposite of the argument type—see the documentation for lmom.ub and lmoms.

Note

If any of the trimming characteristics of the second type of L-moment object (trim, leftrim, or rightrim) have a greater than zero value, then conversion to the L-moment object with named values will not be performed. A message will be provided that the conversion was not performed is provided with a stop(). To clarify, the L-moment object as returned by lmom.ub is not compatible with the concept of trimmed L-moments.

Author(s)

W.H. Asquith

See Also

lmom.ub, lmoms, TLmoms

Examples

lmr <- lmom.ub(c(123,34,4,654,37,78))
lmorph(lmr)
lmorph(lmorph(lmr))

[Package lmomco version 0.96.3 Index]