commit 319a546db61d0e5faa6908cf6a28acd05baa6a28
author Irene <25118334+isteves@users.noreply.github.com> Tue Apr 17 15:37:39 2018 -0700
committer Irene <25118334+isteves@users.noreply.github.com> Tue Apr 17 15:37:39 2018 -0700
tree 7f5835cfbddb5b59a36563a31504da1e0302edc4
parent b1caa27840a86eb17071dc8973b690650aee78f1

add example

R/scroll_box.R

diff --git a/R/scroll_box.R b/R/scroll_box.R
index 44bd096..3d1b805 100644
--- a/R/scroll_box.R
+++ b/R/scroll_box.R
@@ -10,6 +10,20 @@
 #' @param extra_css Extra CSS styles
 #'
 #' @export
+#'
+#' @examples
+#' \dontrun{
+#' # Specify table size by pixels
+#' kable(cbind(mtcars, mtcars), "html") %>%
+#'     kable_styling() %>%
+#'     scroll_box(width = "500px", height = "200px")
+#'
+#' # Specify by percent
+#' kable(cbind(mtcars, mtcars), "html") %>%
+#'     kable_styling() %>%
+#'     scroll_box(width = "100%", height = "200px")
+#' }
+
 scroll_box <- function(kable_input, height = NULL, width = NULL,
                        box_css = "border: 1px solid #ddd; padding: 5px; ",
                        extra_css = NULL) {