tidy up R docs

Author: cpsievert

R/layout.R

@@ -101,9 +101,6 @@ rangeslider <- function(p, start = NULL, end = NULL, ...) {
 #' (see [here](https://github.com/ropensci/plotly/blob/master/inst/examples/rmd/MathJax/index.Rmd) 
 #' for an **rmarkdown** example and 
 #' [here](https://github.com/ropensci/plotly/blob/master/inst/examples/rmd/MathJax/index.Rmd) for a **shiny** example).
-#' @param priority the priority of shiny input events. If `NULL` (the default), then 
-#' [event_data()] becomes invalidated only when the input value changes. If `"event"`,
-#' then the event will always fire, regardless of whether the value has changed. 
 #' @author Carson Sievert
 #' @export
 #' @examples
@@ -134,7 +131,7 @@ rangeslider <- function(p, start = NULL, end = NULL, ...) {
 #' config(p, locale = "zh-CN")
 #' 
 
-config <- function(p, ..., collaborate = TRUE, cloud = FALSE, locale = NULL, mathjax = NULL, priority = NULL) {
+config <- function(p, ..., collaborate = TRUE, cloud = FALSE, locale = NULL, mathjax = NULL) {
 
   if (!is.null(locale)) {
     p$dependencies <- c(
@@ -173,7 +170,6 @@ config <- function(p, ..., collaborate = TRUE, cloud = FALSE, locale = NULL, mat
   }
 
   p$x$config$cloud <- cloud
-  p$x$config$priority <- priority
 
   p
 }

R/shiny.R

@@ -62,6 +62,9 @@ prepareWidget <- function(x) {
 #' with the `source` argument in [plot_ly()] (or [ggplotly()]) to respond to  
 #' events emitted from that specific plot.
 #' @param session a shiny session object (the default should almost always be used).
+#' @param priority the priority of the relevant shiny input. If equal to `"event"`, 
+#' then [event_data()] always triggers re-execution, instead of re-executing
+#' only when the relevant shiny input value changes (the default).
 #' @export
 #' @references 
 #'   * <https://plotly-book.cpsievert.me/shiny-plotly-inputs.html> 
@@ -105,45 +108,3 @@ event_data <- function(
 
   if (is.null(val)) val else fromJSONfunc(val)
 }
-
-
-
-# 
-# 
-# event_data_reactive <- function(
-#   event = c(
-#     "plotly_hover", "plotly_unhover", "plotly_click", "plotly_doubleclick",
-#     "plotly_selected", "plotly_selecting", "plotly_brush", "plotly_brushing", 
-#     "plotly_deselect", "plotly_relayout", "plotly_restyle", "plotly_legendclick", 
-#     "plotly_legenddoubleclick", "plotly_clickannotation", "plotly_afterplot"
-#   ), 
-#   source = "A",
-#   session = shiny::getDefaultReactiveDomain(),
-#   priority = "input"
-# ) {
-#   if (is.null(session)) {
-#     stop("No reactive domain detected. This function can only be called \n",
-#          "from within a reactive shiny context.")
-#   }
-#   
-#   # obtain the input value
-#   event <- match.arg(event)
-#   
-#   # register event on client-side
-#   session$sendCustomMessage(
-#     "plotly-register-event", 
-#     list(event = event, source = source, priority = priority)
-#   )
-#   
-#   # get input_value
-#   src <- sprintf(".clientValue-%s-%s-%s", event, source, priority)
-#   
-#   # legend clicking returns trace(s), which shouldn't be simplified...
-#   fromJSONfunc <- if (event %in% c("plotly_legendclick", "plotly_legenddoubleclick")) from_JSON else jsonlite::fromJSON
-#   
-#   # return reactive
-#   reactive({
-#     val <- session$rootScope()$input[[src]]
-#     if (is.null(val)) val else fromJSONfunc(val)
-#   })
-# }