This function provides special support for adding probability-like axes to an existing plot. The function supports a recurrence interval (RI) axis, normal probability axis (NPP), and standard normal variate (SNV) axis. The function is built around the interface model that standard normal transformation of the values for the respective axis controlled by this function are being plotted; this means that qnorm()
should be wrapped on the values of nonexceedance probability. This is an ease oversight to make (see Examples section below and note use of qnorm(pp)
).
The function provides a convenient interface for labeling and titling two axes, so adjustments to default margins might be desired. The pertinent control is achieved using the par()
function, which might be of the form par(mgp=c(3,0.5,0), mar=c(5,4,4,3))
say for plotting the lmomco axis both on the left and right (see z.par2cdf
for an example).
add.lmomco.axis(side=1, twoside=FALSE, twoside.suppress.labels=FALSE,
side.type=c("NPP", "RI", "SNV"),
otherside.type=c("NA", "RI", "SNV", "NPP"),
alt.lab=NA, alt.other.lab=NA, npp.as.aep=FALSE,
case=c("upper", "lower"),
NPP.control=NULL, RI.control=NULL, SNV.control=NULL, ...)
No value is returned. This function is used for its side effects.
The side of the plot (1=bottom, 2=left, 3=top, 4=right).
A logical triggering whether the tick marks are echoed on the opposite side. This value is forced to FALSE
if otherside.type
is not "NA"
.
A logical to turn off labeling on the opposite side. This is useful if only the ticks (major and minor) are desired.
The axis type for the primary side
.
The optional axis type for the opposite side. The default is a literal not applicable.
A short-cut to change the axis label without having to specify a *.control
argument and its label
attribute. The label attribute of alt.lab
is not NA
is used instead of the defaults. This argument overrides behavior of the otherside.type
labeling so use of alt.lab
only makes sense if otherside.type
is left as NA
.
Similar to alt.lab
but can house an alternative label (see Examples.
Convert nonexceedance probability to exceedance probability, which is a que for alt.other.lab
and nonexceedance probabilities are changed by \(1-F\), but the real coordinates for plotting remain in the nonexceedance probability context.
The will switch between all upper case or mixed case for the default labels.
An optional R list
used to influence the NPP axis.
An optional R list
used to influence the RI axis.
An optional R list
used to influence the SNV axis.
Additional arguments that are passed to the R function Axis
.
W.H. Asquith
prob2T
, T2prob
, add.log.axis