plot.boxcox {EnvStats} | R Documentation |

## Plot Results of Box-Cox Transformations

### Description

Plot the results of calling the function `boxcox`

, which returns an
object of class `"boxcox"`

. Three different kinds of plots are available.

The function `plot.boxcox`

is automatically called by `plot`

when given an object of class `"boxcox"`

. The names of other functions
associated with Box-Cox transformations are listed under Data Transformations.

### Usage

```
## S3 method for class 'boxcox'
plot(x, plot.type = "Objective vs. lambda", same.window = TRUE,
ask = same.window & plot.type != "Ojective vs. lambda",
plot.pos.con = 0.375, estimate.params = FALSE,
equal.axes = qq.line.type == "0-1" || estimate.params, add.line = TRUE,
qq.line.type = "least squares", duplicate.points.method = "standard",
points.col = 1, line.col = 1, line.lwd = par("cex"), line.lty = 1,
digits = .Options$digits, cex.main = 1.4 * par("cex"), cex.sub = par("cex"),
main = NULL, sub = NULL, xlab = NULL, ylab = NULL, xlim = NULL,
ylim = NULL, ...)
```

### Arguments

`x` |
an object of class |

`plot.type` |
character string indicating what kind of plot to create. Only one particular
plot type will be created, unless |

`same.window` |
logical scalar indicating whether to produce all plots in the same graphics
window ( |

`ask` |
logical scalar supplied to the function |

`points.col` |
numeric scalar determining the color of the points in the plot. The default
value is |

**The following arguments can be supplied when plot.type="Q-Q Plots",**

**:**

`plot.type="Tukey M-D Q-Q Plots"`

, or `plot.type="All"`

(supplied to `qqPlot`

)`plot.pos.con` |
numeric scalar between 0 and 1 containing the value of the plotting position
constant used to construct the Q-Q plots and/or Tukey Mean-Difference Q-Q plots.
The default value is |

`estimate.params` |
logical scalar indicating whether to compute quantiles based on estimating the
distribution parameters ( |

`equal.axes` |
logical scalar indicating whether to use the same range on the |

`add.line` |
logical scalar indicating whether to add a line to the plot. If |

`qq.line.type` |
character string determining what kind of line to add to the plot when |

`duplicate.points.method` |
a character string denoting how to plot points with duplicate |

`line.col` |
numeric scalar determining the color of the line in the plot. The default value
is |

`line.lwd` |
numeric scalar determining the width of the line in the plot. The default value
is |

`line.lty` |
numeric scalar determining the line type (style) of the line in the plot.
The default value is |

`digits` |
scalar indicating how many significant digits to print for the distribution
parameters and the value of the objective in the sub-title. The default
value is the current setting of |

**Graphics parameters:**

`cex.main` , `cex.sub` , `main` , `sub` , `xlab` , `ylab` , `xlim` , `ylim` , `...` |
graphics parameters; see |

### Details

The function `plot.boxcox`

is a method for the generic function
`plot`

for the class `"boxcox"`

(see `boxcox.object`

).
It can be invoked by calling `plot`

and giving it an object of
class `"boxcox"`

as the first argument, or by calling `plot.boxcox`

directly, regardless of the class of the object given as the first argument
to `plot.boxcox`

.

Plots associated with Box-Cox transformations are produced on the current graphics device. These can be one or all of the following:

Objective vs.

`\lambda`

.Observed Quantiles vs. Normal Quantiles (Q-Q Plot) for the transformed observations for each of the values of

`\lambda`

.Tukey Mean-Difference Q-Q Plots for the transformed observations for each of the values of

`\lambda`

.

See the help files for `boxcox`

and `qqPlot`

for more
information.

### Value

`plot.boxcox`

invisibly returns the first argument, `x`

.

### Author(s)

Steven P. Millard (EnvStats@ProbStatInfo.com)

### References

Chambers, J. M. and Hastie, T. J. (1992). *Statistical Models in S*.
Wadsworth & Brooks/Cole.

### See Also

`qqPlot`

, `boxcox`

, `boxcox.object`

,
`print.boxcox`

, Data Transformations, `plot`

.

### Examples

```
# Generate 30 observations from a lognormal distribution with
# mean=10 and cv=2, call the function boxcox, and then plot
# the results.
# (Note: the call to set.seed simply allows you to reproduce this example.)
set.seed(250)
x <- rlnormAlt(30, mean = 10, cv = 2)
# Plot the results based on the PPCC objective
#---------------------------------------------
boxcox.list <- boxcox(x)
dev.new()
plot(boxcox.list)
# Look at Q-Q Plots for the candidate values of lambda
#-----------------------------------------------------
plot(boxcox.list, plot.type = "Q-Q Plots", same.window = FALSE)
# Look at Tukey Mean-Difference Q-Q Plots
# for the candidate values of lambda
#----------------------------------------
plot(boxcox.list, plot.type = "Tukey M-D Q-Q Plots", same.window = FALSE)
#==========
# Clean up
#---------
rm(x, boxcox.list)
graphics.off()
```

*EnvStats*version 2.8.1 Index]