Don't run examples on a non-interactive windows environment

(This is mainly to avoid spurious CRAN NOTE on win-builder)

Author: cpsievert

R/add.R

@@ -3,7 +3,7 @@
 #' @param p a plotly visualization
 #' @param data a data frame.
 #' @export
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' plot_ly() %>% add_data(economics) %>% add_trace(x = ~date, y = ~pce)
 add_data <- function(p, data = NULL) {
@@ -41,7 +41,7 @@ add_data <- function(p, data = NULL) {
 #' @author Carson Sievert
 #' @export
 #' @rdname add_trace
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # the `plot_ly()` function initiates an object, and if no trace type
 #' # is specified, it sets a sensible default
@@ -704,7 +704,7 @@ special_attrs <- function(trace) {
 # #' 
 # #' 
 # #' @export
-# #' @examples
+# #' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 # #' 
 # #' x <- rnorm(10)
 # #' plot_ly(x = ~x) %>%

R/animate.R

@@ -28,7 +28,7 @@
 #' @rdname animation
 #' @aliases animation
 #' @author Carson Sievert
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' df <- data.frame(
 #'   x = c(1, 2, 2, 1, 1, 2),

R/api_exports.R

@@ -46,7 +46,7 @@
 #' @author Carson Sievert
 #' @references \url{https://api.plot.ly/v2}
 #' @seealso [signup()]
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' \dontrun{
 #' 

R/dev.R

@@ -9,7 +9,7 @@
 #' or a number specifying the number of spaces to indent. See [jsonlite::prettify].
 #' @param ... other options passed onto [listviewer::jsonedit]
 #' @export
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #'   
 #' plotly_json(plot_ly())
 #' plotly_json(plot_ly(), FALSE)
@@ -32,7 +32,7 @@ plotly_json <- function(p = last_plot(), jsonedit = interactive(), pretty = TRUE
 #' @param jsonedit use `listviewer::jsonedit` to view the JSON?
 #' @param ... other options passed onto `listviewer::jsonedit`
 #' @export
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' s <- schema()
 #' 
 #' # retrieve acceptable `layout.mapbox.style` values

R/group2NA.R

@@ -23,7 +23,7 @@
 #' then `groupNames`, then `ordered`. As long as `groupNames` 
 #' contains valid variable names, new rows will also be inserted to separate 
 #' the groups.
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # note the insertion of new rows with missing values 
 #' group2NA(mtcars, "vs", "cyl")

R/helpers.R

@@ -8,7 +8,7 @@
 #' multiple colorbars.
 #' @author Carson Sievert
 #' @export
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' p <- plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~cyl)
 #' 
@@ -112,7 +112,7 @@ hide_guides <- function(p) {
 #' @param p a plotly object.
 #' @export
 #' @seealso [hide_legend()]
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' p <- plot_ly(mtcars, x = ~wt, y = ~cyl, color = ~cyl)
 #' hide_colorbar(p)
@@ -136,7 +136,7 @@ hide_colorbar <- function(p) {
 #' @param p a plotly object.
 #' @export
 #' @seealso [hide_colorbar()]
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' p <- plot_ly(mtcars, x = ~wt, y = ~cyl, color = ~factor(cyl))
 #' hide_legend(p)
@@ -153,7 +153,7 @@ hide_legend <- function(p) {
 #' 
 #' @param p a plotly or ggplot object.
 #' @export
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # currently no bargl trace type
 #' toWebGL(ggplot() + geom_bar(aes(1:10)))
@@ -197,7 +197,7 @@ plotly_empty <- function(...) {
 #' @author Carson Sievert
 #' @export
 #' @references <https://plotly-r.com/embedding-images.html>
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # a red gradient (from ?as.raster)
 #' r <- as.raster(matrix(hcl(0, 80, seq(50, 80, 10)), nrow = 4, ncol = 5))

R/highlight.R

@@ -52,7 +52,7 @@
 #' @author Carson Sievert
 #' @references \url{https://plotly-r.com/client-side-linking.html}
 #' @seealso [attrs_selected()]
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # These examples are designed to show you how to highlight/brush a *single*
 #' # view. For examples of multiple linked views, see `demo(package = "plotly")` 

R/kaleido.R

@@ -37,7 +37,7 @@
 #'   * `scope`: a reference to the underlying `kaleido.scopes.plotly.PlotlyScope`
 #'     python object. Modify this object to customize the underlying Chromium
 #'     subprocess and/or configure other details such as URL to plotly.js, MathJax, etc. 
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' \dontrun{
 #'   # Save a single image

R/layout.R

@@ -52,7 +52,7 @@ layout.plotly <- function(p, ..., data = NULL) {
 #' \url{https://plotly.com/r/reference/#layout-xaxis-rangeslider}
 #' @export
 #' @author Carson Sievert
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' plot_ly(x = time(USAccDeaths), y = USAccDeaths) %>% 
 #'   add_lines() %>%
@@ -103,7 +103,7 @@ rangeslider <- function(p, start = NULL, end = NULL, ...) {
 #' [here](https://github.com/plotly/plotly.R/blob/master/inst/examples/rmd/MathJax/index.Rmd) for a **shiny** example).
 #' @author Carson Sievert
 #' @export
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # remove the plotly logo and collaborate button from modebar
 #' config(plot_ly(), displaylogo = FALSE, collaborate = FALSE)

R/mathjax.R

@@ -8,7 +8,7 @@
 #' @param x a character vector
 #' @export
 #' @seealso [config]
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' plot_ly(x = c(1, 2, 3, 4), y = c(1, 4, 9, 16)) %>%
 #'   layout(title = TeX("\\text{Some mathjax: }\\alpha+\\beta x")) %>%

R/orca.R

@@ -27,7 +27,7 @@
 #' @author Carson Sievert
 #' @md
 #' @rdname orca
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' \dontrun{
 #' # NOTE: in a headless environment, you may need to set `more_args="--enable-webgl"`

R/partial_bundles.R

@@ -19,7 +19,7 @@
 #' @param minified whether or not to use a minified js file (non-minified file can be useful for debugging plotly.js)
 #' @author Carson Sievert
 #' @export
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # ----------------------------------------------------------------------
 #' # This function is always safe to use when rendering a single 

R/plotly.R

@@ -89,7 +89,7 @@
 #'  \item For quick, accurate, and searchable plotly.js reference: [schema()]
 #' }
 #' @export
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' \dontrun{
 #' 
 #' # plot_ly() tries to create a sensible plot based on the information you 
@@ -263,7 +263,7 @@ plot_mapbox <- function(data = data.frame(), ...) {
 #' @export
 #' @author Carson Sievert
 #' @seealso [plot_ly()], [plot_mapbox()], [ggplotly()] 
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' map_data("world", "canada") %>%
 #'   group_by(group) %>%
@@ -308,7 +308,7 @@ plot_geo <- function(data = data.frame(), ..., offline = FALSE) {
 #' @export
 #' @author Carson Sievert
 #' @seealso [plot_ly()], [plot_mapbox()], [ggplotly()] 
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' \dontrun{
 #' hc <- hclust(dist(USArrests), "ave")
@@ -400,7 +400,7 @@ get_xy <- function(node) {
 #' @param x a plotly object.
 #' @param ... other options passed onto `htmlwidgets::createWidget`
 #' @export
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' trace <- list(x = 1, y = 1)
 #' obj <- list(data = list(trace), layout = list(title = "my plot"))
@@ -553,7 +553,7 @@ locale_dependency <- function(locale) {
 #'
 #' @param p a plotly object
 #' @export
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' \dontrun{
 #' p1 <- plot_ly()

R/plotly_build.R

@@ -8,7 +8,7 @@
 #' @param p a ggplot object, or a plotly object, or a list.
 #' @param registerFrames should a frame trace attribute be interpreted as frames in an animation?
 #' @export
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #'
 #' p <- plot_ly(economics, x = ~date, y = ~pce)
 #' # the unevaluated plotly object

R/plotly_data.R

@@ -13,7 +13,7 @@
 #' 
 #' @name plotly_data
 #' @export
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # use group_by() to define groups of visual markings
 #' p <- txhousing %>%

R/proxy.R

@@ -10,7 +10,7 @@
 #'   until after the next time all of the outputs are updated.
 #' @rdname plotlyProxy
 #' @export 
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' 
 #' if (require("shiny") && interactive()) {

R/style.R

@@ -11,7 +11,7 @@
 #' @seealso [api_download_plot()]
 #' @author Carson Sievert
 #' @export
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # style() is especially useful in conjunction with ggplotly()
 #' # It allows you to leverage the underlying plotly.js library to change 

R/subplots.R

@@ -28,7 +28,7 @@
 #' @return A plotly object
 #' @export
 #' @author Carson Sievert
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' # pass any number of plotly objects to subplot()
 #' p1 <- plot_ly(economics, x = ~date, y = ~uempmed)

R/toRGB.R

@@ -4,7 +4,7 @@
 #' @return hexadecimal colour value (if is.na(x), return "transparent" for compatibility with Plotly)
 #' @export
 #' @seealso [showRGB()]
-#' @examples 
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' toRGB("steelblue") 
 #' # [1] "rgba(70,130,180,1)"
@@ -66,7 +66,7 @@ toRGB <- function(x, alpha = 1) {
 #' @param ... arguments passed along to `scales::show_col`.
 #' @export
 #' @author Carson Sievert
-#' @examples
+#' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
 #' showRGB(toRGB(colors()), labels = FALSE)
 showRGB <- function(x, ...) {