Draws a histogram

ly_hist(
  fig,
  x,
  data = figure_data(fig),
  breaks = "Sturges",
  freq = TRUE,
  include.lowest = TRUE,
  right = TRUE,
  color = NULL,
  alpha = 1,
  lname = NULL,
  lgroup = NULL,
  ...
)

Arguments

fig

figure to modify

x

either a vector to be passed to hist or an object of class "histogram"

data

an optional data frame, providing the source for x

breaks, freq, include.lowest, right

parameters passed to hist

color

color for the glyph - a hex code (with no alpha) or any of the 147 named CSS colors, e.g 'green', 'indigo' - for glyphs with both fill and line properties, see "Handling color" below

alpha

the alpha transparency of the glyph between 0 (transparent) and 1 (opaque) - if glyph has both fill and color properties, see "Handling alpha" below

lname

layer name

lgroup

layer group

...

additional parameters for fine control over fill and line properties (see "Additional parameters" below)

Handling color

The color parameter is a high-level plot attribute that provides default behavior for coloring glyphs.

  • When using a glyph that only has line properties, this will be the color of the line.

  • When using a glyph that has has line and fill properties, this will be the color of the line and the fill, with the alpha level of the fill reduced by 50%.

  • If full control over fill and line color is desired, the fill_color and line_color attributes can be specified explicitly and will override color.

When color is NULL and fill_color or line_color are not specified, the color will be chosen from the theme.

Handling alpha

The alpha is a high-level plot attribute that sets the transparency of the glyph being plotted.

  • When using a glyph that only has line properties, this will be the alpha of the line.

  • When using a glyph that has has line and fill properties, this will be the alpha of the line and the alpha of the fill will be set to 50% of this value.

  • Individual fill and line alpha can be specified with fill_alpha and line_alpha and will override alpha.

Additional parameters

fill_colorcolor to use to fill the glyph with - a hex code (with no alpha) or any of the 147 named CSS colors, e.g 'green', 'indigo'
fill_alphatransparency value between 0 (transparent) and 1 (opaque)
line_colorcolor to use to stroke lines with - a hex code (with no alpha) or any of the 147 named CSS colors, e.g 'green', 'indigo'
line_widthstroke width in units of pixels
line_alphatransparency value between 0 (transparent) and 1 (opaque)
line_joinhow path segments should be joined together 'miter' 'round' 'bevel'
line_caphow path segments should be terminated 'butt' 'round' 'square'
line_dasharray of integer pixel distances that describe the on-off pattern of dashing to use
line_dash_offsetthe distance in pixels into the line_dash that the pattern should start from

See also

Examples

h <- figure(width = 600, height = 400) %>% ly_hist(eruptions, data = faithful, breaks = 40, freq = FALSE) %>% ly_density(eruptions, data = faithful) h