predicate print_dispatch behavior on getOption("boxr.print_tibble") (#179)

* predicate print_dispatch behavior on getOption("boxr.print_tibble")

* limit printing of data.frame to 10 rows

* tweak NEWS item

* bump version

* add to boxr_options(), documentation. bump version

Author: ijlyttle

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: boxr
 Type: Package
 Title: Interface for the 'Box.com API'
-Version: 0.3.5.9008
+Version: 0.3.5.9009
 Authors@R: c(
     person("Brendan", "Rocks", email = "[email protected]",
            role = c("aut")),

NEWS.md

@@ -2,6 +2,8 @@
 
 ## Improvements
 
+* Some return objects can be printed as tibble (vs. data-frame). To enable this behavior, set `options(boxr.print_tibble = TRUE)` (perhaps in your `.Rprofile`).
+
 * new tools to manage [collaborations](https://developer.box.com/reference/resources/collaboration/):
   - `box_dir_invite()` is deprecated in favor of `box_collab_create()`.
   - adds `box_collab_create()`, which supports file and group based collaborations. 

R/boxr_misc.R

@@ -213,6 +213,8 @@ box_getwd <- function() {
 #'     `id` `(numeric)`, and `name` `(character)`.}
 #'   \item{`boxr.wd.path`}{`character`, path to the Box working-directory.}
 #'   \item{`boxr.token`}{Object with S3 class `Token2.0` (`httr::Token2.0`).}
+#'   \item{`boxr_token_jwt`}{Object with S3 class `request` (`httr::request`).}
+#'   \item{`boxr.print_tibble`}{`logical`, indicates to print as tibble where available.}
 #' }
 #' 
 #' @export
@@ -224,7 +226,8 @@ boxr_options <- function() {
     "boxr.verbose",
     "boxr.progress",
     "boxr.interactive",
-    "boxr_token_jwt"
+    "boxr_token_jwt",
+    "boxr.print_tibble"
   )
 
   o <- options()

R/boxr_s3_classes.R

@@ -542,10 +542,14 @@ print_df_summary <- function(file_list, msg_list) {
   dummy_var <- mapply(print_df, file_list, msg_list)
 }
 
-
 print_dispatch <- function(x, ...) {
 
-  if (requireNamespace("tibble", quietly = TRUE)) {
+  has_tibble <- requireNamespace("tibble", quietly = TRUE) 
+  
+  # should this default TRUE or FALSE?
+  print_tibble <- getOption("boxr.print_tibble") %||% FALSE 
+
+  if (has_tibble && print_tibble) {
     print_using_tibble(x, ...)
   } else {
     print_using_df(x, ...)
@@ -555,14 +559,21 @@ print_dispatch <- function(x, ...) {
 }
 
 print_using_df <- function(x, ...) {
+
+  has_tibble <- requireNamespace("tibble", quietly = TRUE) 
 
   df <- as.data.frame(x)
 
   cat("--- printing as data.frame ---\n")
-  print(df, ...)
+  print(df, max = 10 * ncol(df), ...)
   cat("\n")
-  cat("Use `as.data.frame()` to extract full results.\n")
 
+  if (has_tibble) {
+    cat("Use `as.data.frame()` or `as_tibble()` to extract full results.\n")
+  } else {
+    cat("Use `as.data.frame()` to extract full results.\n")    
+  }
+
   invisible(x)
 }
 

R/zzz.R

@@ -6,13 +6,14 @@
 .onLoad <- function(libname, pkgname) {
   op <- options()
   op.boxr <- list(
-    boxr.token       = NULL,
-    boxr_token_jwt   = NULL,
-    boxr.wd          = list(id = 0, name = "All Files"),
-    boxr.wd.path     = "",
-    boxr.verbose     = TRUE,
-    boxr.progress    = TRUE,
-    boxr.interactive = TRUE
+    boxr.token        = NULL,
+    boxr_token_jwt    = NULL,
+    boxr.wd           = list(id = 0, name = "All Files"),
+    boxr.wd.path      = "",
+    boxr.verbose      = TRUE,
+    boxr.progress     = TRUE,
+    boxr.interactive  = TRUE,
+    boxr.print_tibble = FALSE
   )
   toset <- !(names(op.boxr) %in% names(op))
   if (any(toset)) options(op.boxr[toset])