plotly / plotly/plotly.R

renderPlotly function gives two errors when running via do.call()

Open
#2,108 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
2.7k
Forks
641
PR merge metrics
No merged PRs in 30d

Description

The renderPlotly function gives two errors when running it via do.call().

Thi first is that quoting done in renderPlotly doesn't seem to be accepted by the subsequent Shiny functions.

The second is because do.call adds another layer of frames the label = sys.call(-1)[[1]] in shiny::installExprFunction() does not correctly capture the function name for use as a label. This seems to be hardcoded in most shiny render functions such as renderPlot().

I think this is due to changes made in the shiny code to support quosures (https://github.com/rstudio/shiny/pull/3472). I don't have any experience with quoting and quosures but I put my current workaround at the end of the reprex.

library(plotly)
library(shiny)

a_plot <- plot_ly(x = 1:3, y = 2:4)

# Usual call of renderPlotly works
plot_redered <-renderPlotly(a_plot)

# Using do.call gives an error
plot_redered <-do.call(renderPlotly, list(expr = a_plot))
#> Error in exprToQuo(expr, env, quoted = TRUE): Don't know how to convert 'plotly' to a function; a quosure or quoted expression was expected

# Put the plot in a quosure gives a different error
q_plot <- rlang::quo(plot_ly(x = 1:3, y = 2:4))
plot_redered <-do.call(renderPlotly, list(expr = q_plot, quoted = T))
#> Error in as.character(label): cannot coerce type 'closure' to vector of type 'character'

# Modified function that manually specifies label = "renderPlotly" when calling shiny::installExprFunction and uses enquote() in place of substitute()
renderPlotly_w_label <- function (expr, env = parent.frame(), quoted = FALSE){
  if (!quoted) {
    quoted <- TRUE
    expr <- enquote(expr)
  }
  shiny::installExprFunction(expr, "func", env, quoted, label = "renderPlotly")
  expr2 <- quote(getFromNamespace("prepareWidget", "plotly")(func()))
  renderFunc <- htmlwidgets::shinyRenderWidget(expr2, plotlyOutput, environment(), 
                                               quoted, cacheHint = list(label = "renderPlotly", 
                                                                        userExpr = expr))
  shiny::snapshotPreprocessOutput(renderFunc, function(value) {
    json <- from_JSON(value)
    json$x <- json$x[setdiff(names(json$x), c("visdat", 
                                              "cur_data", "attrs"))]
    to_JSON(json)
  })
}

# This succeeds
plot_redered <-do.call(renderPlotly_w_label, list(expr = a_plot))

Created on 2022-02-17 by the reprex package (v2.0.1)

Standard output and standard error
x Install the styler package in order to use `style = TRUE`.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the renderPlotly function and reproduce the do.call() examples in the issue, then inspect how shiny::installExprFunction handles quoting, quosures, and labels. Done means renderPlotly works through do.call() without either reported error; no specific source file or test is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
data-visualization
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.