probPlot | R Documentation |
Creates a probability plot.
probPlot(x, truncate = NA, FLIP = FALSE, distribution = "normal", alpha = 0.4, Plot = list(name = "", what = "points", type = "solid", width = "standard", symbol = "circle", filled = TRUE, size = 0.09, color = "black"), yaxis.log = TRUE, yaxis.range = c(NA, NA), ylabels = 11, xlabels = 11, CDF = !RI, xtitle = ifelse(CDF, "Cumulative Probability", "Exceedence Probability"), RI = FALSE, RItitle = "Recurrence Interval, in years", ytitle = deparse(substitute(x)), caption = "", margin = c(NA, NA, NA, NA), ...) ## Default S3 method: probPlot(x, truncate = NA, FLIP = FALSE, distribution = "normal", alpha = 0.4, Plot = list(name = "", what = "points", type = "solid", width = "standard", symbol = "circle", filled = TRUE, size = 0.09, color = "black"), yaxis.log = TRUE, yaxis.range = c(NA, NA), ylabels = "Auto", xlabels = 11, CDF = !RI, xtitle = ifelse(CDF, "Cumulative Probability", "Exceedence Probability"), RI = FALSE, RItitle = "Recurrence Interval, in years", ytitle = deparse(substitute(x)), caption = "", margin = c(NA, NA, NA, NA), ...)
x |
the data to plot. Missing values are allowed and ignored. |
truncate |
truncate the data at the specified value. See Details. |
FLIP |
if TRUE, then plot the cumulative distribution. Otherwise, plot as flipped data (largest values on left). |
distribution |
the name of the desired function converting from probabilities to coordinates. |
alpha |
the alpha value of the function for computing plotting positions. |
Plot |
parameters defining the characteristics of the plot. See
|
yaxis.log |
logical, if |
yaxis.range |
set the range of the y axis. See Details. |
ylabels |
set the y-axis labels. See |
xlabels |
set the x-axis labels. See |
CDF |
logical, if |
xtitle |
the x-axis title (also called x-axis caption). |
RI |
logical, if |
RItitle |
the top x-axis title if |
ytitle |
the y-axis title (also called y-axis caption). |
caption |
the figure caption. |
margin |
set the plot area margins, in units of lines of text. Generally
all NA or the output from |
... |
parameters for the distribution function. If any parameter is specified, then an attempt is made to draw the fit between the computed distribution and the observed data. |
Truncation of the data to plot (x
) results in a conditional
probability plot. For any numeric value for truncate
, the values in
x
less than or equal to truncate
are not plotted and the
remaining values are plotted at their conditional probability (the
probability computed with all values). The behavior for the default value
for truncate
= NA, depends on yaxis.log
. If yaxis.log
is TRUE, then truncate
is treated as though it was 0; otherwise
truncate
is treated as though it was -Inf
, which results in no
truncation.
For linear axes, the range can be set to virtually any pair of values. For log axes, the choice of range is more resticted—for less than one log-cycle, powers of whole numbers can be used; from 1 to about 3 log cycles, the choces should be powers of 3 or 10; and for more than 3 log cycles, the range sould be expressed only in powers of 10.
Information about the graph.
A call should be made to setPage
to set up the graphics
environment before calling probPlot
.
setPage
, ecdfPlot
, qqPlot
## Not run: set.seed(1) X <- rlnorm(32) setGD() probPlot(X) # For more details of probPlot see vignette(topic="ProbabilityPlots", package="smwrGraphs") demo(topic="FlowDur-Measurements", package="smwrGraphs") ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.