R/plotly.R

In alteryx/flightdeck: Interactive Dashboards for Predictive Models

#' Create an interactive plot using plotly.
#'
#' This function is a lightweight wrapper around plotly.js. For complete
#' documentation, please refer to \url{https://plot.ly/javascript/reference/}.
#'
#' @param data list of traces to plot.
#' @param layout list consisting of the layout to use for the plot.
#' @param config list consisting of configuration to use for the plot.
#' @param width width of the plot.
#' @param height height of the plot.
#' @import htmlwidgets
#' @export
#' @example inst/examples/fdPlotly.R
fdPlotly <- function(data, layout = NULL, config = NULL, width = NULL,
    height = NULL) {
  # forward options using x
  x = list(
    data = data, layout = layout, config = config
  )

  # create widget
  htmlwidgets::createWidget(
    name = 'plotlyLite',
    x,
    width = width,
    height = height,
    sizingPolicy = htmlwidgets::sizingPolicy(
      browser.fill = TRUE, defaultWidth = "100%", defaultHeight = 400
    ),
    package = 'flightdeck'
  )
}