R/dbGetPlot.R

In rsgl: An Implementation of the 'SGL' Graphics Language

#' Generate a plot from a SGL statement
#'
#' `dbGetPlot` takes a database connection and a SGL statement
#' and returns the corresponding plot.
#'
#' @param con A database connection (as returned by [DBI::dbConnect()])
#' @param sgl_stmt A SGL statement (string)
#'
#' @return The plot defined by the SGL statement (a `sgl_plot` object)
#'
#' @examples
#' library(duckdb)
#' con <- dbConnect(duckdb())
#' dbWriteTable(con, "cars", cars)
#' p <- dbGetPlot(con, "
#'   visualize
#'     horsepower as x,
#'     miles_per_gallon as y
#'   from cars
#'   using points
#' ")
#' print(p)
#'
#' @export
dbGetPlot <- function(con, sgl_stmt) { # nolint: object_name_linter
  rgs <- sgl_to_rgs(sgl_stmt)
  dfs <- result_dfs(rgs, con)
  validate_semantics(rgs, dfs)
  sgl_plot <- rgs
  sgl_plot$result_dfs <- dfs
  structure(
    sgl_plot,
    class = "sgl_plot"
  )
}