lcoratdiagram: Create a Special Object of L-moments and L-comoments

In wasquith/lmomcoexta: Extensions to lmomco Package that Diverge from Core L-moment Support

Description

This function computes an lcoratdiagram object used by other functions of this package. The object is specially designed for exploratory L-moment analysis of bivariate data. The lcoratdiagram object is a complex assembly of L-moments, L-comoments, Spearman's Rho, Kendall's Tau, and other elements. The function provides for specialized large-scale visualization of data. The core data are identified by a site variable (site), the paired x and y values (x, y) for each site, and an optional grouping or classification variable (group). The x and y data could also be either left or right censored, which are identified by indicator variable. A multi-page PDF output file (xyfile) of the bivariate relation between x and y and corresponding plot of nonexceedance probabilities by plotting position is created. The limits of the bivariate plot (xlim and ylim) can be controlled as well as the axis transformation (xtrans, ytrans). The labels of the bivariate plot also can be set (xlab, ylab). The function computes the first 5 L-moments and L-comoments, therefore dataset having less than 6 values are skipped by default (n.to.next), but the user is welcome to increase this amount. The function also supports the simulation of bivariate normal distributions by a simulation count (nsim). These simulated values can be useful for the visualization (plotlcoratdiagram or plotlratdiagram) of the uncertainty of the relations between L-moment ratios and L-comoment ratios.

Usage

lcoratdiagram(x, y, site, group=NULL,
              xlc=NULL, ylc=NULL, xrc=NULL, yrc=NULL,
              nsim=0, n.to.next=6, verbose=TRUE,
              xyfile="XY.pdf", xlim=NULL, ylim=NULL,
              xtrans=function(x) { return(x) },
              ytrans=function(y) { return(y) },
              xlab = "X VARIABLE",
              ylab = "Y VARIABLE", ...)

Arguments

lcoratdiagram	A object from lcoratdiagmra().
site	The site id for each data value.
group	An optional grouping value, which can be used to enhance the visualization of the plotlcoratdiagram and plotlratdiagram options.
x	.
y	.
xlc	.
ylc	.
xrc	Right censoring of x variable by indicator variable (not implemented).
yrc	Right censoring by y variable indicator variable (not implemented).
nsim	.
n.to.next	.
verbose	A logical that controls whether message updates on status are shown.
xyfile	.
xlim	.
ylim	.
xtrans	.
ytrans	.
xlab	.
ylab	.
...	Additional arguments to pass.

Value

An R list is returned.

Author(s)

W.H. Asquith

See Also

plotlcoratdiagram, plotlratdiagram

Examples

# 

wasquith/lmomcoexta documentation built on May 30, 2019, 4:11 p.m.