rbokeh (version 0.5.2)

ly_abline: Add an "abline" layer to a Bokeh figure

Description

Draws one or more straight lines.

Usage

ly_abline(
  fig,
  a = NULL,
  b = NULL,
  v = NULL,
  h = NULL,
  coef = NULL,
  color = "black",
  alpha = NULL,
  width = 1,
  type = 1,
  legend = NULL,
  lname = NULL,
  lgroup = NULL,
  ...
)

Arguments

fig

figure to modify

a, b

the intercept and slope of the line(s) to draw

v

the x value(s) for vertical lines

h

the y value(s) for horizontal lines

coef

a vector of length two giving the intercept and slope

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'

alpha

transparency value for the line between 0 (transparent) and 1 (opaque)

width

stroke width in units of pixels

type

an integer between 1 and 6 matching the lty property in par or an array of integer pixel distances that describe the on-off pattern of dashing to use

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

…

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

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

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	an integer between 1 and 6 matching the lty property in par or an array of integer pixel distances that describe the on-off pattern of dashing to use

See Also

Other layer functions: 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_quantile(), ly_ray(), ly_rect(), ly_segments(), ly_text(), ly_wedge()

Examples

# NOT RUN {
z <- lm(dist ~ speed, data = cars)
p <- figure() %>%
  ly_points(cars, hover = cars) %>%
  ly_lines(lowess(cars), legend = "lowess") %>%
  ly_abline(z, type = 2, legend = "lm", width = 2)
p
# }
# NOT RUN {
# abline with mixed axes for h and v
figure() %>%
  ly_points(1:26, letters) %>%
  ly_abline(h = "j") %>%
  ly_abline(v = 10)

# multiple hv lines
figure() %>%
  ly_points(1:10) %>%
  ly_abline(v = 1:10) %>%
  ly_abline(h = 1:10)

# multiple ab lines
figure() %>%
  ly_points(0:10) %>%
  ly_abline(0, seq(0, 1, by = 0.1))
# }