plot.gofCensored.Rd
Plot the results of calling the function gofTestCensored
, which returns
an object of class "gofCensored"
when testing the goodness-of-fit of a set of
data to a distribution. Five different kinds of plots are available.
The function plot.gofCensored
is automatically called by plot
when given an object of class "gofCensored"
.
# S3 method for class 'gofCensored'
plot(x, plot.type = "Summary",
captions = list(PDFs = NULL, CDFs = NULL, QQ = NULL, MDQQ = NULL, Results = NULL),
x.labels = list(PDFs = NULL, CDFs = NULL, QQ = NULL, MDQQ = NULL),
y.labels = list(PDFs = NULL, CDFs = NULL, QQ = NULL, MDQQ = NULL),
same.window = FALSE, ask = same.window & plot.type == "All", hist.col = "cyan",
fitted.pdf.col = "black", fitted.pdf.lwd = 3 * par("cex"), fitted.pdf.lty = 1,
prob.method = "michael-schucany", plot.pos.con = 0.375, ecdf.col = "cyan",
fitted.cdf.col = "black", ecdf.lwd = 3 * par("cex"),
fitted.cdf.lwd = 3 * par("cex"), ecdf.lty = 1, fitted.cdf.lty = 2, add.line = TRUE,
digits = ifelse(plot.type == "Summary", 2, .Options$digits), test.result.font = 1,
test.result.cex = ifelse(plot.type == "Summary", 0.9, 1) * par("cex"),
test.result.mar = c(0, 0, 3, 0) + 0.1,
cex.main = ifelse(plot.type == "Summary", 1.2, 1.5) * par("cex"),
cex.axis = ifelse(plot.type == "Summary", 0.9, 1) * par("cex"),
cex.lab = ifelse(plot.type == "Summary", 0.9, 1) * par("cex"),
main = NULL, xlab = NULL, ylab = NULL, xlim = NULL, ylim = NULL, add.om.title = TRUE,
oma = if (plot.type == "Summary" & add.om.title) c(0, 0, 4, 0) else c(0, 0, 0, 0),
om.title = NULL, om.font = 2, om.cex.main = 1.5 * par("cex"), om.line = 0, ...)
an object of class "gofCensored"
. See gofCensored.object
for details.
character string indicating what kind of plot to create. Only one particular
plot type will be created, unless plot.type="All"
, in which case all plots
will be created sequentially. The possible values of plot.type
are:
"Summary"
(the default), "PDFs: Observed and Fitted"
,
"CDFs: Observed and Fitted"
, "Q-Q Plot"
, "Tukey M-D Q-Q Plot"
,
"Test Results"
, and "All"
. See the DETAILS section for more information.
a list with 1 to 5 components with the names "PDFs"
, "CDFs"
,
"QQ"
, "MDQQ"
, and/or "Results"
. Each component either has
the value NULL
or else it is a character string containing the title for that
particular kind of plot. When the component has the value NULL
(the default),
a default title is used. This argument is useful when you are creating more than
one kind of plot with a single call to plot.gofCensored
(i.e., when
plot.type="Summary"
or plot.type="All"
) and you want to specify titles
different from the default ones. If you are creating only one kind of plot,
then you can just use the main
argument to specify a title different
from the default one.
a list of 1 to 4 components with the names "PDFs"
, "CDFs"
, "QQ"
,
and/or "MDQQ"
. Each component either has the value
NULL
or else it is a character string containing the label for the
\(x\)-axis for that particular kind of plot. When the component has the value
NULL
(the default), a default \(x\)-axis label is used.
This argument is useful when you are creating more than
one kind of plot with a single call to plot.gofCensored
(i.e., when
plot.type="Summary"
or plot.type="All"
)
and you want to specify \(x\)-axis
labels different from the default ones. If you are creating only one plot,
then you can just use the xlab
argument to
specify an \(x\)-axis label different from the default one.
a list of 1 to 4 components with the names "PDFs"
, "CDFs"
, "QQ"
,
and/or "MDQQ"
. Each component either has the value
NULL
or else it is a character string containing the label for the
\(y\)-axis for that particular kind of plot. When the component has the value
NULL
(the default), a default \(y\)-axis label is used.
This argument is useful when you are creating more than
one kind of plot with a single call to plot.gofCensored
(i.e., when
plot.type="Summary"
or plot.type="All"
)
and you want to specify \(y\)-axis
labels different from the default ones. If you are creating only one plot,
then you can just use the ylab
argument to
specify a \(y\)-axis label different from the default one.
logical scalar indicating whether to produce all plots in the same graphics
window (same.window=TRUE
), or to create a new graphics
window for each separate plot (same.window=FALSE
; the default).
The argument is relevant only when plot.type="All"
.
logical scalar supplied to the function devAskNewPage
, indicating
whether to prompt the user before creating a new plot within a single graphics
window. The default value is FALSE
unless same.window=TRUE
and
plot.type == "All"
.
scalar indicating how many significant digits to print for the distribution
parameters. If plot.type == "Summary"
, the default value is
digits=2
, otherwise it is .Options$digits
(i.e., the current
setting of options("digits")
).
This argument is ignored when plot.type="PDFs: Observed and Fitted"
.
Arguments associated with plot.type="PDFs: Observed and Fitted"
:
a character string or numeric scalar determining the color of the histogram
used to display the distribution of the observed values. The default value is
hist.col="cyan"
. See the entry for col
in the R help file for
par
for more information.
a character string or numeric scalar determining the color of the fitted PDF
(which is displayed as a line for continuous distributions and a histogram for
discrete distributions). The default value is fitted.pdf.col="black"
.
See the entry for col
in the R help file for par
for more information.
numeric scalar determining the width of the line used to display the fitted PDF.
The default value is fitted.pdf.lwd=3*par("cex")
.
See the entry for lwd
in the R help file for par
for more information.
numeric scalar determining the line type used to display the fitted PDF.
The default value is fitted.pdf.lty=1
.
See the entry for lty
in the R help file for par
for more information.
Arguments associated with plot.type="CDFs: Observed and Fitted"
:
character string indicating what method to use to compute the plotting positions
(empirical probabilities). Possible values are: "kaplan-meier"
(product-limit method of Kaplan and Meier (1958)), "modified kaplan-meier"
(modification of Kaplan-Meier method), "nelson"
(hazard plotting method of Nelson (1972)), "michael-schucany"
(generalization of the product-limit method due to Michael and Schucany (1986)), and "hirsch-stedinger"
(generalization of the product-limit method due to Hirsch and Stedinger (1987)).
The default value is prob.method="michael-schucany"
.
The "nelson"
method is only available for censoring.side="right"
, and
the "modified kaplan-meier"
method is only available for censoring.side="left"
.
See the help file for ppointsCensored
for more explanation.
NOTE: This argument is also used to determine the plotting position method
for the Q-Q plot (plot.type="Q-Q Plot"
), or the
Tukey Mean-Difference Q-Q plot (plot.type="Tukey M-D Q-Q Plot"
).
numeric scalar between 0 and 1 containing the value of the plotting position
constant used to construct the observed (empirical) CDF. The default value is
plot.pos.con=0.375
. See the help files for
ecdfPlot
and qqPlot
for more information and the
motivation for this choice of value.
This argument is used only if prob.method
is equal to
"michael-schucany"
or "hirsch-stedinger"
.
NOTE: This argument is also used to determine the value of the
plotting position constant for the Q-Q plot (plot.type="Q-Q Plot"
), or the
Tukey Mean-Difference Q-Q plot (plot.type="Tukey M-D Q-Q Plot"
).
a character string or numeric scalar determining the color of the line
used to display the empirical CDF. The default value is
ecdf.col="cyan"
. See the entry for col
in the R help file for
par
for more information.
a character string or numeric scalar determining the color of the line used
to display the fitted CDF. The default value is fitted.cdf.col="black"
.
See the entry for col
in the R help file for par
for more information.
numeric scalar determining the width of the line used to display the empirical CDF.
The default value is ecdf.lwd=3*par("cex")
.
See the entry for lwd
in the R help file for par
for more information.
numeric scalar determining the width of the line used to display the fitted CDF.
The default value is fitted.cdf.lwd=3*par("cex")
.
See the entry for lwd
in the R help file for par
for more information.
numeric scalar determining the line type used to display the empirical CDF.
The default value is ecdf.lty=1
.
See the entry for lty
in the R help file for par
for more information.
numeric scalar determining the line type used to display the fitted CDF.
The default value is fitted.cdf.lty=2
.
See the entry for lty
in the R help file for par
for more information.
Arguments associated with plot.type="Q-Q Plot"
or plot.type="Tukey M-D Q-Q Plot"
:
As explained above, prob.method
and plot.pos.con
are used for these plot
types. Also:
logical scalar indicating whether to add a line to the plot. If add.line=TRUE
and plot.type="Q-Q Plot"
, a 0-1 line is added to the plot.
If add.line=TRUE
and plot.type="Tukey M-D Q-Q Plot"
, a horizontal
line at \(y=0\) is added to the plot. The default value is add.line=TRUE
.
Arguments associated with plot.type="Test Results"
numeric scalar indicating which font to use to print out the test results.
The default value is test.result.font=1
. See the description of the
font
argument in the help file for par
for more information.
You may get better results if you use a font number that corresponds to a fixed
font (e.g., courier).
numeric scalar indicating the value of cex
to use to print out the
test results. The default value is 0.9*par("cex")
when
plot.type="Summary"
, otherwise it is par("cex")
.
See the description of the cex
argument in the help file for
par
for more information.
numeric vector indicating the value of mar
to use to print out the
test results. The default value is test.result.mar=c(0, 0, 3, 0) + 0.1
.
See the description of the mar
argument in the help file for
par
for more information.
Arguments associated with plot.type="Summary"
logical scalar indicating whether to add a title in the outer margin when plot.type="Summary"
. The default value is add.om.title=TRUE
.
character string containing the outer margin title. The default value is om.title=NULL
, which will result in a default title.
numeric scalar indicating the font to use for the outer margin. The default
value is om.font=2
.
numeric scalar indicating the value of cex
for the outer margin title.
The default value is 1.75 * par("cex")
.
numeric scalar indicating the line to place the outer margin title on. The
default value is om.line=0.5
.
Graphics parameters:
additional graphics parameters. See the help file for par
.
The function plot.gofCensored
is a method for the generic function
plot
for objects that inherit from the class "gofCensored"
(see gofCensored.object
).
It can be invoked by calling plot
and giving it an object of
class "gofCensored"
as the first argument, or by calling
plot.gofCensored
directly, regardless of the class of the object given
as the first argument to plot.gofCensored
.
Plots associated with the goodness-of-fit test are produced on the current graphics device. These can be one or all of the following:
Observed distribution overlaid with fitted distribution
(plot.type="PDFs: Observed and Fitted"
). See the help files for
hist
and pdfPlot
. Note: This kind of
plot is only available for singly-censored data.
Observed empirical distribution overlaid with fitted cumulative distribution
(plot.type="CDFs: Observed and Fitted"
). See the help file for
cdfCompareCensored
.
Observed quantiles vs. fitted quantiles (Q-Q Plot)
(plot.type="Q-Q Plot"
). See the help file for qqPlotCensored
.
Tukey mean-difference Q-Q plot (plot.type="Tukey M-D Q-Q Plot"
).
See the help file for qqPlotCensored
.
Results of the goodness-of-fit test (plot.type="Test Results"
).
See the help file for print.gofCensored
.
See the help file for gofTestCensored
for more information.
plot.gofCensored
invisibly returns the first argument, x
.
Chambers, J. M. and Hastie, T. J. (1992). Statistical Models in S. Wadsworth & Brooks/Cole.
# Create an object of class "gofCensored", then plot the results.
#----------------------------------------------------------------
gofCensored.obj <- with(EPA.09.Ex.15.1.manganese.df,
gofTestCensored(Manganese.ppb, Censored, test = "sf"))
mode(gofCensored.obj)
#> [1] "list"
#[1] "list"
class(gofCensored.obj)
#> [1] "gofCensored"
#[1] "gofCensored"
# Summary plot (the default)
#---------------------------
dev.new()
plot(gofCensored.obj)
#> Warning: Cannot construct histogram for multiply censored data when complete observations are between censoring levels
# Make your own titles for the summary plot
#------------------------------------------
dev.new()
plot(gofCensored.obj, captions = list(CDFs = "Compare CDFs",
QQ = "Q-Q Plot", Results = "Results"), om.title = "Summary")
#> Warning: Cannot construct histogram for multiply censored data when complete observations are between censoring levels
# Just the Q-Q Plot
#------------------
dev.new()
plot(gofCensored.obj, plot.type="Q-Q")
# Make your own title for the Q-Q Plot
#-------------------------------------
dev.new()
plot(gofCensored.obj, plot.type="Q-Q", main = "Q-Q Plot")
#==========
# Clean up
#---------
rm(gofCensored.obj)
graphics.off()