Learn R Programming

rbokeh (version 0.4.2)

ly_quantile: Add a "quantile" layer to a Bokeh figure

Description

Draws quantiles

Usage

ly_quantile(fig, x, group = NULL, data = figure_data(fig), probs = NULL, distn = stats::qunif, ncutoff = 200, color = NULL, alpha = 1, legend = TRUE, lname = NULL, lgroup = NULL, visible = TRUE, ...)

Arguments

fig
figure to modify
x
numeric vector or field name of variable to compute sample quantiles for
group
values or field name of a grouping variable to break quantile computations up by
data
an optional data frame, providing the source for x
probs
numeric vector of probabilities with values in [0,1] at which to compute quantiles - if NULL, every point of x is a quantile
distn
quantile function to use on the x-axis (e.g. qnorm) - default is qunif,
ncutoff
if the length of x exceeds this value and probs is not specified, compute quantiles at ncutoff points
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
legend
either a logical specifying not to plot a legend for this layer (FALSE) or a string indicating the name of the legend entry for this layer (note that when mapping plot attributes to variables in data, a legend is automatically created and does not need to be specified - see "Mapped plot attributes and legends" below)
lname
layer name
lgroup
layer group
visible
should the layer be visible?
...
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.

Mapped plot attributes and legends

When specifying an input data frame for a layer through the data argument, columns of data can be used to specify various plot attributes such as color, etc. For example, with ly_points(..., data = iris, color = Species), the Species variable is used to determine how to color the points. Here, Species is "mapped" to the color attribute. Both continuous and categorical variables can be mapped. In the case of continuous variables, the range is cut into slices and attributes are applied to each interval. The mapping from the values of the variable to the actual plot attributes is determined based on the theme.

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_hist, ly_image_url, ly_image, ly_lines, ly_map, ly_multi_line, ly_oval, ly_patch, ly_points, ly_polygons, ly_quadratic, ly_ray, ly_rect, ly_segments, ly_text, ly_wedge