rbokeh (version 0.4.2)

grid_plot: Create a Bokeh grid plot from a list of Bokeh figures

Description

Create a Bokeh grid plot from a list of Bokeh figures

Usage

grid_plot(figs, width = NULL, height = NULL, nrow = 1, ncol = 1, byrow = TRUE, xlim = NULL, ylim = NULL, same_axes = FALSE, simplify_axes = TRUE, y_margin = NULL, x_margin = NULL, link_data = FALSE)

Arguments

figs

list of Bokeh figures - see details for what is acceptable

width

width of the entire grid plot in pixels - if NULL, the sum of the grid widths of columns will be used - if not NULL, the widths of the plots will be proportionately shrunk to meet the specified width

height

height of the entire grid plot in pixels - if NULL, the sum of the grid heights of rows will be used - if not NULL, the heights of the plots will be proportionately shrunk to meet the specified height

nrow

number of rows in the grid

ncol

number of columns in the grid

byrow

populate the grid by row according to the order of figure elements supplied in params

xlim

the extent of the plotting area in the x-dimension to be applied to every panel (original individual panel limits will be honored if not specified).

ylim

the extent of the plotting area in the y-dimension to be applied to every panel (original individual panel limits will be honored if not specified).

same_axes

logical or vector of two logicals specifying whether the x and/or y axis limits should be the same for each plot in the grid

simplify_axes

logical or vector of logicals specifying whether to simply the x and/or y axes (only show the axes along the bottom and left sides of the grid) - only valid if same_axes is TRUE for the axis

x_margin, y_margin

specify the margin space in pixels to be left for axes when using simplify_axes=TRUE

link_data

logical - should an attempt be made to join the data sources of each plot for linked brushing? (see details)

Details

The figs parameter can either be a list of figures or a list of lists of figures. If the latter, the list structure will determine the layout, with each super-list of figures defining a single row of the grid. If the former, the parameters nrow and ncol and byrow are used to determine the layout. The grid is from top to bottom left to right.

If link_data is TRUE, then an effort will be made to link all data sources that are common among the different figures in the plot. Note that at this point, only data sources that are specified in the data argument to the different layer functions are checked.

Examples

idx <- split(1:150, iris$Species)
figs <- lapply(idx, function(x) {
  figure(width = 300, height = 300) %>%
    ly_points(Sepal.Length, Sepal.Width, data = iris[x,],
      hover = list(Sepal.Length, Sepal.Width))
})

# 1 row, 3 columns
grid_plot(figs)
# specify xlim and ylim to be applied to all panels
grid_plot(figs, xlim = c(4, 8), ylim = c(1.5, 4.5))
# unnamed list will remove labels
grid_plot(unname(figs))
# 2 rows, 2 columns
grid_plot(figs, nrow = 2)
# x and y axis with same (and linked) limits
grid_plot(figs, same_axes = TRUE)
# x axis with same (and linked) limits
grid_plot(figs, same_axes = c(TRUE, FALSE))
# x axis with same (and linked) limits and custom xlim
grid_plot(figs, same_axes = c(TRUE, FALSE), xlim = c(5, 7))
# send lists instead of specifying nrow and ncol
grid_plot(list(
  c(list(figs[[1]]), list(figs[[2]])),
  list(figs[[3]])
))
# a null entry will be skipped in the grid
figs[1] <- list(NULL)
grid_plot(figs, nrow = 2)

# link data across plots in the grid (try box_select tool)
# (data sources must be the same)
tools <- c("pan", "wheel_zoom", "box_zoom", "box_select", "resize", "reset")
p1 <- figure(tools = tools) %>%
  ly_points(Sepal.Length, Sepal.Width, data = iris, color = Species)
p2 <- figure(tools = tools) %>%
  ly_points(Petal.Length, Petal.Width, data = iris, color = Species)
grid_plot(list(p1, p2), same_axes = TRUE, link_data = TRUE)