documentation changes for R CMD check

plotly · May 18, 2016 · 6d7ddad · 6d7ddad
1 parent dd9a3fa
commit 6d7ddad
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 2 deletions.
diff --git a/R/print.R b/R/print.R
@@ -29,6 +29,7 @@ knit_print.plotly_hash <- function(x, options, ...) {
 #' Print a 'built' plotly object in a knitr doc
 #' 
 #' @param x a plotly object
+#' @param options knitr options.
 #' @param ... additional arguments
 #' @export
 knit_print.plotly_built <- knit_print.plotly_hash

diff --git a/man/ggplotly.Rd b/man/ggplotly.Rd
diff --git a/man/knit_print.plotly_built.Rd b/man/knit_print.plotly_built.Rd
diff --git a/vignettes/intro.Rmd b/vignettes/intro.Rmd
@@ -1,7 +1,9 @@
 ---
 title: "An overview of plotly's R API"
 author: "Carson Sievert"
-output: rmarkdown::html_vignette
+output: 
+  rmarkdown::html_vignette:
+    self_contained: false
 vignette: >
   %\VignetteEngine{knitr::rmarkdown} 
   %\VignetteIndexEntry{Plotly DSL}

diff --git a/vignettes/subplot.Rmd b/vignettes/subplot.Rmd
@@ -4,7 +4,7 @@ author: "Carson Sievert"
 output: 
   rmarkdown::html_vignette:
     toc: true
-    standalone: false
+    self_contained: false
 vignette: >
   %\VignetteEngine{knitr::rmarkdown} 
   %\VignetteIndexEntry{subplot}
@@ -17,6 +17,17 @@ knitr::opts_chunk$set(
   comment = "#>",
   fig.width = 7
 )
+# someday we may want to do pngs to reduce size...
+# printly <- function(p, options, ...) { 
+#   p <- layout(p, height = options$fig.height, width = options$fig.width)
+#   u <- plotly::plotly_POST(p, filename = Sys.time())$url
+#   sprintf(
+#     "<a href='%s'> <img src='%s.png' style='%s' /> </a>", 
+#     u, u, "max-width:100%"
+#   )
+# }
+# assignInNamespace("knit_print.plotly_hash", printly, asNamespace("plotly"))
+# assignInNamespace("knit_print.plotly_built", printly, asNamespace("plotly"))
 ```
 
 ## Introduction