Shiny apps in examples/documentation are broken

[daattali]

Many times when I search for some R plotly documentation, I come across a page with a broken shiny app, which essentially renders that page useless. I usually ignored it, but I realize now that it would have been much more productive to make note and report it! So I'll start now :)

The app here doesn't exist: https://plot.ly/r/shinyapp-linked-click/

[daattali]

Another broken example:

The documentation for plotlyProxy has no example usages, but says that running the following shows an example.

plotly_example("shiny", "proxy_relayout")

I get an error with that:

> plotly_example("shiny", "proxy_relayout")
Error in editor(file = file, title = title) : 
  argument "name" is missing, with no default

[cpsievert]

I've reported the missing link here plotly/documentation#1451 (issues with documentation that you encounter on https://plot.ly/r/ should be reported there)

Huh, I can't reproduce the editor error. What version of plotly do you have? Does this work on the machine you're using? If so, what does getOption("editor") return?

file.edit(dir(system.file(package = "plotly", "examples", "shiny", "proxy_relayout"), full.names = T))

[daattali]

Plotly from commit a689263

The file.edit command does work.

> getOption("editor")
function (name, file, title) 
{
    if (is.null(name) || is.function(name)) {
        if (is.null(name)) {
            if (!is.null(file) && nzchar(file)) 
                targetFile <- file
            else targetFile <- scratchFile
        }
        else {
            functionSrc <- .rs.deparseFunction(name, TRUE, FALSE)
            targetFile <- scratchFile
            writeLines(functionSrc, targetFile)
        }
        if (.Call("rs_editFile", targetFile)) {
            newFunc <- try(eval.parent(parse(targetFile)), silent = TRUE)
            if (inherits(newFunc, "try-error")) {
                stop(newFunc, "You can attempt to correct the error using ", 
                  title, " = edit()")
            }
            return(newFunc)
        }
        else {
            stop("Error occurred while editing function '", 
                name, "'")
        }
    }
    else edit(name, file, title, editor = defaultEditor)
}
<environment: 0x000000000b8ac4b0>

[cpsievert]

Interesting, thanks. Do you know where this option setting is coming from (perhaps RStudio)? What platform are you on (also, some devtools::session_info() would be great)?

BTW, for a temporary workaround, you can do edit = FALSE

plotly_example("shiny", "proxy_relayout", edit = FALSE)

[daattali]

I'm not sure where that setting is coming from - it's not something I manually set.

> devtools::session_info()
- Session info -----------------------------------------------------------------------
 setting  value                       
 version  R version 3.6.0 (2019-04-26)
 os       Windows 7 x64 SP 1          
 system   x86_64, mingw32             
 ui       RStudio                     
 language (EN)                        
 collate  English_Canada.1252         
 ctype    English_Canada.1252         
 tz       America/New_York            
 date     2019-08-12                  

- Packages ---------------------------------------------------------------------------
 package     * version    date       lib source                               
 assertthat    0.2.1      2019-03-21 [1] CRAN (R 3.6.0)                       
 backports     1.1.4      2019-04-10 [1] CRAN (R 3.6.0)                       
 callr         3.2.0      2019-03-15 [1] CRAN (R 3.6.0)                       
 cli           1.1.0      2019-03-19 [1] CRAN (R 3.6.0)                       
 colorspace    1.4-1      2019-03-18 [1] CRAN (R 3.6.0)                       
 crayon        1.3.4      2017-09-16 [1] CRAN (R 3.6.0)                       
 data.table    1.12.2     2019-04-07 [1] CRAN (R 3.6.0)                       
 desc          1.2.0      2018-05-01 [1] CRAN (R 3.6.0)                       
 devtools      2.0.2      2019-04-08 [1] CRAN (R 3.6.0)                       
 digest        0.6.18     2018-10-10 [1] CRAN (R 3.6.0)                       
 dplyr         0.8.1      2019-05-14 [1] CRAN (R 3.6.0)                       
 fs            1.3.1      2019-05-06 [1] CRAN (R 3.6.0)                       
 ggplot2     * 3.1.1      2019-04-07 [1] CRAN (R 3.6.0)                       
 glue          1.3.1      2019-03-12 [1] CRAN (R 3.6.0)                       
 gtable        0.3.0      2019-03-25 [1] CRAN (R 3.6.0)                       
 htmltools     0.3.6      2017-04-28 [1] CRAN (R 3.6.0)                       
 htmlwidgets   1.4        2019-07-10 [1] Github (ramnathv/htmlwidgets@853b1b0)
 httr          1.4.0      2018-12-11 [1] CRAN (R 3.6.0)                       
 jsonlite      1.6        2018-12-07 [1] CRAN (R 3.6.0)                       
 lazyeval      0.2.2      2019-03-15 [1] CRAN (R 3.6.0)                       
 magrittr      1.5        2014-11-22 [1] CRAN (R 3.6.0)                       
 memoise       1.1.0      2017-04-21 [1] CRAN (R 3.6.0)                       
 munsell       0.5.0      2018-06-12 [1] CRAN (R 3.6.0)                       
 pillar        1.4.0      2019-05-11 [1] CRAN (R 3.6.0)                       
 pkgbuild      1.0.3      2019-03-20 [1] CRAN (R 3.6.0)                       
 pkgconfig     2.0.2      2018-08-16 [1] CRAN (R 3.6.0)                       
 pkgload       1.0.2      2018-10-29 [1] CRAN (R 3.6.0)                       
 plotly      * 4.9.0.9000 2019-08-10 [1] Github (ropensci/plotly@a689263)     
 plyr          1.8.4      2016-06-08 [1] CRAN (R 3.6.0)                       
 prettyunits   1.0.2      2015-07-13 [1] CRAN (R 3.6.0)                       
 processx      3.3.1      2019-05-08 [1] CRAN (R 3.6.0)                       
 ps            1.3.0      2018-12-21 [1] CRAN (R 3.6.0)                       
 purrr         0.3.2      2019-03-15 [1] CRAN (R 3.6.0)                       
 R6            2.4.0      2019-02-14 [1] CRAN (R 3.6.0)                       
 Rcpp          1.0.1      2019-03-17 [1] CRAN (R 3.6.0)                       
 remotes       2.0.4      2019-04-10 [1] CRAN (R 3.6.0)                       
 rlang         0.4.0      2019-06-25 [1] CRAN (R 3.6.0)                       
 rprojroot     1.3-2      2018-01-03 [1] CRAN (R 3.6.0)                       
 rstudioapi    0.10       2019-03-19 [1] CRAN (R 3.6.0)                       
 scales        1.0.0      2018-08-09 [1] CRAN (R 3.6.0)                       
 sessioninfo   1.1.1      2018-11-05 [1] CRAN (R 3.6.0)                       
 testthat      2.1.1      2019-04-23 [1] CRAN (R 3.6.0)                       
 tibble        2.1.1      2019-03-16 [1] CRAN (R 3.6.0)                       
 tidyr         0.8.3      2019-03-01 [1] CRAN (R 3.6.0)                       
 tidyselect    0.2.5      2018-10-11 [1] CRAN (R 3.6.0)                       
 usethis       1.5.0      2019-04-07 [1] CRAN (R 3.6.0)                       
 viridisLite   0.3.0      2018-02-01 [1] CRAN (R 3.6.0)                       
 withr         2.1.2      2018-03-15 [1] CRAN (R 3.6.0)                       
 yaml          2.2.0      2018-07-25 [1] CRAN (R 3.6.0)

[greenLauren]

Also here: https://plot.ly/r/shinyapp-UN-simple/