document

Author: cpsievert

R/add.R

@@ -21,15 +21,7 @@ add_data <- function(p, data = NULL) {
 
 #' Add trace(s) to a plotly visualization
 #' 
-#' @param p a plotly or ggplot object.
-#' @param ... These arguments are documented in the references section below.
-#' Note that acceptable arguments depend on the trace type.
-#' @param color Either a variable name or a vector to use for color mapping.
-#' @param symbol Either a variable name or a (discrete) vector to use for symbol encoding.
-#' @param size A variable name or numeric vector to encode the size of markers.
-#' @param linetype Either a variable name or a (discrete) vector to use for linetype encoding.
-#' @param data A data frame to associate with this trace (optional). If not 
-#' provided, arguments are evaluated using the data frame in \code{\link{plot_ly}()}.
+#' @inheritParams add_trace
 #' @param inherit inherit attributes from \code{\link{plot_ly}()}?
 #' @param z a numeric matrix
 #' @param x the x variable.

R/plotly.R

@@ -29,7 +29,8 @@
 #' \code{linetypes}. To avoid scaling, wrap with \code{\link{I}()}.
 #' @param linetypes A character vector of line types. 
 #' Either valid \link{par} (lty) or plotly dash codes may be supplied.
-#' @param size A variable name or numeric vector to encode the size of markers.
+#' @param size A formula containing a name or expression yielding a numeric vector. 
+#' Values are scaled according to the range specified in \code{sizes}.
 #' @param sizes A numeric vector of length 2 used to scale sizes to pixels.
 #' @param split A formula containing a name or expression. Similar to
 #' \code{\link{group_by}()}, but ensures at least one trace for each unique

R/plotly_build.R

@@ -144,10 +144,10 @@ plotly_build.plotly <- function(p) {
     # I don't think we ever want mesh3d's data attrs
     dataArrayAttrs <- if (identical(trace[["type"]], "mesh3d")) NULL else names(Attrs)[as.logical(isArray)]
     allAttrs <- c(
-      dataArrayAttrs, special_attrs(trace), npscales(), ".plotlyGroupIndex", 
+      dataArrayAttrs, special_attrs(trace), npscales(),
       # for some reason, text isn't listed as a data array in some traces
       # I'm looking at you scattergeo...
-      "text"
+      ".plotlyGroupIndex", "text"
     )
     tr <- trace[names(trace) %in% allAttrs]
     # TODO: does it make sense to "train" matrices/2D-tables (e.g. z)?
@@ -276,7 +276,7 @@ plotly_build.plotly <- function(p) {
       p$x$layout$showlegend <- FALSE
     } else {
       # shrink the colorbar
-      idx <- which(vapply(p$x$data, function(x) inherits(x, "plotly_colorbar"), logical(1)))
+      idx <- which(vapply(p$x$data, inherits, logical(1), "plotly_colorbar"))
       p$x$data[[idx]]$marker$colorbar <- modify_list(
         list(len = 1/2, lenmode = "fraction", y = 1, yanchor = "top"),
         p$x$data[[idx]]$marker$colorbar