type_histogram – tinyplot

Histogram plot type

Description

Type function for histogram plots. type_hist is an alias for type_histogram.

Usage

type_histogram(
  breaks = "Sturges",
  freq = NULL,
  right = TRUE,
  free.breaks = FALSE,
  drop.zeros = TRUE
)

type_hist(
  breaks = "Sturges",
  freq = NULL,
  right = TRUE,
  free.breaks = FALSE,
  drop.zeros = TRUE
)

Arguments

`breaks`	Passed to `hist`. 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’ of `hist`), 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).
`right`	logical; if `TRUE`, the histogram cells are right-closed (left open) intervals.
`free.breaks`	Logical indicating whether the breakpoints should be computed separately for each group or facet? Default is `FALSE`, meaning that the breakpoints are computed from the full dataset; thus ensuring common bin widths across each group/facet. Can also use `free` as an acceptable argument alias. Ignored if there are no groups and/or facets.
`drop.zeros`	Logical indicating whether bins with zero counts should be dropped before plotting. Default is `TRUE`. Note that switching to `FALSE` may interfere with faceted plot behaviour if `facet.args = list(free)`, since the `x` variable is effectively recorded over the full range of the x-axis (even if it does not extend over this range for every group).

Examples

library("tinyplot")

# "histogram"/"hist" type convenience string(s)
tinyplot(Nile, type = "histogram")

# Use `type_histogram()` to pass extra arguments for customization
tinyplot(Nile, type = type_histogram(breaks = 30))

tinyplot(Nile, type = type_histogram(breaks = 30, freq = FALSE))

# etc.

# Grouped histogram example
tinyplot(
    ~Petal.Width | Species,
    type = "histogram",
    data = iris
)

# Faceted version
tinyplot(
    ~Petal.Width, facet = ~Species,
    type = "histogram",
    data = iris
)

# For visualizing faceted histograms across varying scales, you may also wish
# to impose free histogram breaks too (i.e., calculate breaks separately for
# each group). Compare:

# free facet scales + shared histogram breaks, versus...
tinyplot(
    ~Petal.Width, facet = ~Species,
    facet.args = list(free = TRUE),
    type = type_histogram(),
    data = iris
)

# ... free facet scales + free histogram breaks
tinyplot(
    ~Petal.Width, facet = ~Species,
    facet.args = list(free = TRUE),
    type = type_histogram(free = TRUE),
    data = iris
)