ghist: ghistograms

Description Usage Arguments

View source: R/gplots.R

Description

The generic function ghist computes a histogram of the given data values. If plot = TRUE, the resulting object of class "histogram" is plotted by gplot.histogram before it is returned.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
ghist(x, ...)

## Default S3 method:
ghist(x, breaks = "Sturges", freq = NULL,
  probability = !freq, include.lowest = TRUE, right = TRUE,
  density = NULL, angle = 45, col = "white", border = NULL,
  main = paste("Histogram of", xname), xlim = range(breaks), ylim = NULL,
  xlab = xname, ylab, axes = TRUE, plot = TRUE, labels = FALSE,
  nclass = NULL, warn.unused = TRUE, grid = TRUE, col.grid = "grey90",
  col.acc = "white", ...)

Arguments

x

a vector of values for which the histogram is desired.

...

further arguments and graphical parameters passed to plot.histogram and thence to title and axis (if plot = TRUE).

breaks

one of:

  • a vector giving the breakpoints between histogram cells,

  • a function to compute the vector of breakpoints,

  • a single number giving the number of cells for the histogram,

  • a character string naming an algorithm to compute the number of cells (see ‘Details’),

  • a function to compute the number of cells.

In the last three cases the number is a suggestion only; as the breakpoints will be set to pretty values, the number is limited to 1e6 (with a warning if it was larger). If breaks is a function, the x vector is supplied to it as the only argument (and the number of breaks is only limited by the amount of available memory).

freq

logical; if TRUE, the histogram graphic is a representation of frequencies, the counts component of the result; if FALSE, probability densities, component density, are plotted (so that the histogram has a total area of one). Defaults to TRUE if and only if breaks are equidistant (and probability is not specified).

probability

an alias for !freq, for S compatibility.

include.lowest

logical; if TRUE, an x[i] equal to the breaks value will be included in the first (or last, for right = FALSE) bar. This will be ignored (with a warning) unless breaks is a vector.

right

logical; if TRUE, the histogram cells are right-closed (left open) intervals.

density

the density of shading lines, in lines per inch. The default value of NULL means that no shading lines are drawn. Non-positive values of density also inhibit the drawing of shading lines.

angle

the slope of shading lines, given as an angle in degrees (counter-clockwise).

col

a colour to be used to fill the bars. The default of NULL yields unfilled bars.

border

the color of the border around the bars. The default is to use the standard foreground color.

main

these arguments to title have useful defaults here.

xlim

the range of x and y values with sensible defaults. Note that xlim is not used to define the histogram (breaks), but only for plotting (when plot = TRUE).

ylim

the range of x and y values with sensible defaults. Note that xlim is not used to define the histogram (breaks), but only for plotting (when plot = TRUE).

xlab

these arguments to title have useful defaults here.

ylab

these arguments to title have useful defaults here.

axes

logical. If TRUE (default), axes are draw if the plot is drawn.

plot

logical. If TRUE (default), a histogram is plotted, otherwise a list of breaks and counts is returned. In the latter case, a warning is used if (typically graphical) arguments are specified that only apply to the plot = TRUE case.

labels

logical or character string. Additionally draw labels on top of bars, if not FALSE; see plot.histogram.

nclass

numeric (integer). For S(-PLUS) compatibility only, nclass is equivalent to breaks for a scalar or character argument.

warn.unused

logical. If plot = FALSE and warn.unused = TRUE, a warning will be issued when graphical parameters are passed to hist.default().

grid

logical; if TRUE, a background grid will be drawn

col.grid

grid color

col.acc

grid accent color


raredd/plotr documentation built on Nov. 13, 2018, 7:05 a.m.