ly_boxplot {rbokeh} | R Documentation

## Add a "boxplot" layer to a Bokeh figure

### Description

Add a "boxplot" layer to a Bokeh figure

### Usage

    ly_boxplot(fig, x, y = NULL, data = figure_data(fig), width = 0.9,
      coef = 1.5, color = "blue", alpha = 1, hov_color = NULL,
      hov_alpha = NULL, ns_color = NULL, ns_alpha = NULL, sel_color = NULL,
      sel_alpha = NULL, outlier_glyph = 1, outlier_size = 10, lname = NULL,
      lgroup = NULL, ...)

### Arguments

`fig` | Figure to modify.
`x` | Either a numeric vector or a factor.
`y` | eEither a numeric vector or a factor.
`data` | An optional data frame, providing the source for x and y.
`width` | Width of each box, a value between 0 (no width) and 1 (full width).
`coef` | See `boxplot.stats`.
`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 the glyph has both fill and color properties, see "Handling alpha" below.
`hov_color` | Color for the glyph when it is hovered The same rules in the "Handling color" section apply.
`hov_alpha` | The alpha transparency of the glyph when it is not hovered The same rules in the "Handling alpha" section apply.
`ns_color` | Color for the glyph when it is not selected The same rules in the "Handling color" section apply.
`ns_alpha` | The alpha transparency of the glyph when it is not not selected The same rules in the "Handling alpha" section apply.
`sel_color` | Color for the glyph when it is selected. The same rules in the "Handling color" section apply.
`sel_alpha` | The alpha transparency of the glyph when it is not selected. The same rules in the "Handling alpha" section apply.
`outlier_glyph` | The glyph used to plot the outliers. If set to `NA`, no outlier points are plotted. Run `point_types()` for possible values.
`outlier_size` | The size of the glyph used to plot outliers. If set to `NA`, no outlier points are plotted.
`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
`line_dash_offset` | the distance in pixels into the line_dash that the pattern should start from

### See Also

Other layer functions: `ly_annular_wedge`, `ly_annulus`, `ly_arc`, `ly_bar`, `ly_bezier`, `ly_contour`, `ly_crect`, `ly_curve`, `ly_density`, `ly_hist`, `ly_image_url`, `ly_image`, `ly_lines`, `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

    figure(ylab = "Height (inches)", width = 600) %>%
      ly_boxplot(voice.part, height, data = lattice::singer)

[Package rbokeh version 0.6.3 Index]