probPretty: Pretty Axis

View source: R/probPretty.R

probPrettyR Documentation

Pretty Axis

Description

Constructs information for making a nicely formatted probability axis. A support function for creating probability axes.

Usage

probPretty(x, hard = FALSE, labels = "Auto", style = "probability",
  exceedence = TRUE, priority = "label", distribution = "normal",
  ...)

Arguments

x

axis coordinates in range 0-1 or 0-100 allowed and assumed if max(x) > 1. Note that only the range (min and max) are needed. Missing values allowed, but ignored.

hard

logical force min(x) and max(x) as axis limits, otherwise use "nice" limits.

labels

an estimate of the number of labels desired, or specific label points. If vector, then can be expressed as character strings, which are converted to numeric and automatically scaled. Default is "Auto", which is 9 if minimum x is greater than .01 and 11 otherwise.

style

can be either "probability" or "percent" indicates how the labels are formatted.

exceedence
TRUE exceedence probs and additional recurrence interval labels
FALSE cumulative probabilities
priority
"label" "nice" labels given priority for selection
"positions" uniform separation given priority for selection
distribution

the name of the probability function, defaults to normal.

...

options for the distribution function.

Value

Information about the axis labels.

See Also

probPlot


USGS-R/smwrGraphs documentation built on Oct. 11, 2022, 6:11 a.m.