rbokeh (version 0.5.2)

ly_hist: Add a "hist" layer to a Bokeh figure

Description

Draws a histogram

Usage

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_color	color 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_alpha	transparency value between 0 (transparent) and 1 (opaque)
line_color	color 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_width	stroke width in units of pixels
line_alpha	transparency value between 0 (transparent) and 1 (opaque)
line_join	how path segments should be joined together 'miter' 'round' 'bevel'
line_cap	how path segments should be terminated 'butt' 'round' 'square'
line_dash	array of integer pixel distances that describe the on-off pattern of dashing to use

See Also

Other layer functions: ly_abline(), ly_annular_wedge(), ly_annulus(), ly_arc(), ly_bar(), ly_bezier(), ly_boxplot(), ly_contour(), ly_crect(), ly_curve(), ly_density(), ly_image_url(), ly_image(), ly_lines(), ly_map(), ly_multi_line(), ly_oval(), ly_patch(), ly_points(), ly_polygons(), ly_quadratic(), ly_quantile(), ly_ray(), ly_rect(), ly_segments(), ly_text(), ly_wedge()

Examples

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