probPlot.lcens: Probability Plot

In USGS-R/smwrQW: Tools for censored data analysis

Probability Plot

Description

Produces a probability plot: methods for "lcens" and "qw" data.

Usage

## S3 method for class 'lcens'
probPlot(x, truncate, FLIP = FALSE, distribution = "normal",
  alpha = 0.4, Plot = list(name = "Uncensored", 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 = TRUE,
  xtitle = "Cumulative Probability", RI, RItitle,
  ytitle = deparse(substitute(x)), caption = "", margin = c(NA, NA, NA,
  NA), Censored = list(name = "Left censored", what = "points", symbol =
  "circle", filled = FALSE, size = 0.09, color = "black"), ...)

## S3 method for class 'qw'
probPlot(x, truncate, FLIP = FALSE, distribution = "normal",
  alpha = 0.4, Plot = list(name = "Uncensored", 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 = TRUE,
  xtitle = "Cumulative Probability", RI, RItitle,
  ytitle = deparse(substitute(x)), caption = "", margin = c(NA, NA, NA,
  NA), Censored = list(name = "Left censored", what = "points", symbol =
  "circle", filled = FALSE, size = 0.09, color = "black"), ...)

Arguments

x	the data to plot. Missing values are removed before plotting.
truncate	not used for left-censored data.
FLIP	if TRUE, the plot the cumumlative distribution. Otherwise, plot as flipped data (largest values on left). This is not related to computing statistics by the flipped Kaplan-Meier method.
distribution	the name of the desired function converting from probabilities to coordinates.
alpha	the alpha value of the function for computing plotting positions.
Plot	control parameters of the uncensored data plot.
yaxis.log	log-transform the y axis?
yaxis.range	set the range of the y axis.
ylabels	set the y-axis labels. See linearPretty for details.
xlabels	set the x-axis labels. See probPretty for details.
CDF	if TRUE, then label with increasing probabilities. Otherwise label with decreasing probabilities.
xtitle	the x-axis title.
RI	not used for left-censored data.
RItitle	not used for left-censored data.
ytitle	the y-axis title.
caption	the figure caption.
margin	the parameters of the margin of the plot area.
Censored	control parameters of the left-censored data plot.
...	parameters for the distribution function or other method functions.

Details

The control parameters for left-censored data, Censored, are the same as those for uncensored data, Plot. See setPlot for details.

Value

Information about the graph.

See Also

qqPlot.lcens

Examples

## Not run: 
set.seed(1932)
Xu <- rlnorm(32)
setPage("sq") # required page set up
probPlot(as.lcens(Xu, 1.0))

## End(Not run)

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