mosaic (version 0.9-0)

xhistogram: Augmented histograms

Description

The mosaic package adds some additional functionality to histogram, making it simpler to obtain certain common histogram adornments. This is done be resetting the default panel and prepanel functions used by histogram.

Usage

xhistogram(x, data = NULL, panel = panel.xhistogram, type = "density",
  center = NULL, width = NULL, ...)
xhistogramBreaks(x, center = NULL, width = NULL, nint, ...)
prepanel.xhistogram(x, breaks = xhistogramBreaks, ...)
panel.xhistogram(x, dcol = trellis.par.get("plot.line")$col, dalpha = 1,
  dlwd = 2, gcol = trellis.par.get("add.line")$col, glwd = 2,
  fcol = trellis.par.get("superpose.polygon")$col, dmath = dnorm,
  verbose = FALSE, dn = 100, args = NULL, labels = FALSE,
  density = NULL, under = FALSE, fit = NULL, start = NULL,
  type = "density", v, h, groups = NULL, center = NULL, width = NULL,
  breaks, nint = round(1.5 * log2(length(x)) + 1), stripes = c("vertical",
  "horizontal", "none"), alpha = 1, ...)

Arguments

x

a formula or a numeric vector

data

a data frame in which to evaluate x

panel

a panel function

type

one of 'density', 'count', or 'percent'

nint

approximate number of bins

breaks

break points for histogram bins, a function for computing such, or a method hist knows about given as a character string. When using the mosaic package defaults,

...

additional arguments passed to histogram and (by default when the mosaic package has been loaded) on to panel.xhistogram.

dcol

color of density curve

dalpha

alpha for density curve

gcol

color of guidelines

fcol

fill color for histogram rectangles

dmath

density function for density curve overlay

verbose

be verbose?

dn

number of points to sample from density curve

dlwd,glwd

like lwd but affecting the density line and guide lines, respectively

args

a list of additional arguments for dmath

labels

should counts/densities/precents be displayed or each bin?

density

a logical indicating whether to overlay a density curve

under

a logical indicating whether the density layers should be under or over other layers of the plot.

fit

a character string describing the distribution to fit. Known distributions include "exponential", "normal", "lognormal", "poisson", "beta", "geometric", "t"

start

numeric value passed to fitdistr

center

center of one of the bins

width

width of the bins

groups

as per histogram

stripes

one of "vertical", "horizontal", or "none", indicating how bins should be striped when groups is not NULL

h,v

a vector of values for additional horizontal and vertical lines

alpha

transparency level

Value

• xhistogramBreaks returns a vector of break points

See Also

histogram

Examples

histogram(~age | substance, HELPrct, v=35, fit='normal')
histogram(~age, HELPrct, labels=TRUE, type='count')
histogram(~age, HELPrct, groups=cut(age, seq(10,80,by=10)))
histogram(~age, HELPrct, groups=sex, stripes='horizontal')
histogram(~racegrp, HELPrct, groups=substance,auto.key=TRUE)
xhistogramBreaks(1:10, center=5, width=1)
xhistogramBreaks(1:10, center=5, width=2)
xhistogramBreaks(0:10, center=15, width=3)
xhistogramBreaks(1:100, center=50, width=3)
xhistogramBreaks(0:10, center=5, nint=5)