plotBoxes.Rd

% File man/plotBoxes.Rd
% Part of the DEVISE package, https://github.com/cwendorf/DEVISE

\name{plotBoxes}
\alias{plotBoxes}
\alias{addBoxes}
\title{Plot Boxes}
\description{Provides a boxplot for each group or variable.}

\usage{
\method{plotBoxes}{default}(variable, ...)

\method{plotBoxes}{data.frame}(frame, add=FALSE, main=NULL, ylab="Outcome", xlab="", ylim=NULL, offset=0, scale=.8, border="black", col=rgb(0, 0, 0, 0), values=TRUE)

\method{plotBoxes}{formula}(formula, add=FALSE, main=NULL, ylab="Outcome", xlab="", ylim=NULL, offset=0, scale=.8, border="black", col=rgb(0, 0, 0, 0), values=TRUE)
}

\arguments{
\item{variable}{a numeric vector of data values}
\item{frame}{a set of (non-empty) numeric vectors of data values}
\item{formula}{a formula of the form \code{lhs ~ rhs} where \code{lhs} is a numeric variable giving the data values and \code{rhs} a factor giving the corresponding groups}
\item{add}{whether the plot should added to the existing plot}
\item{ylab}{a label for the y-axis}
\item{xlab}{a label for the x-axis}
\item{main}{a custom title for the graph}
\item{ylim}{custom limits for the y axis}
\item{offset}{a value indicating the offset of the boxplot}
\item{scale}{a value that indicates the width of the boxplot}
\item{col}{a value for the shaded color of the boxplot}
\item{border}{a value for the border color of the boxplot}
\item{values}{whether the values should be added to the boxplot}
\item{digits}{the specified number of decimal places}
}

\details{
`plotBoxes` can be used to initialize a new plot or add to an existing plot (using the `add` argument). `addBoxes` is identical to `plotBoxes` without the need to utilize the `add` argument.
}

\value{
The returned plot contains the following components:
\item{LW}{the lower whisker}
\item{LH}{the lower hinge}
\item{Mdn}{the median value}
\item{UH}{the upper hinge}
\item{UW}{the upper whisker}
}