R/inspect_objects.R

In shinyEventLogger: Logging Events in Shiny Apps

#' Copying objects to global environment
#'
#' With \code{inspect_objects} you can copy an object to the global environment
#' for further debugging or developing.
#'
#' @param ... Named objects to be copy to the global environment.
#' If there is only one unnamed object, its name in the global environment
#' will be the same as the name of the object passed to \code{...}.
#'
#' @export
#'
#' @examples
#' if (interactive()) {
#'
#'   set_logging()
#'   shiny::shinyApp(
#'     ui = shiny::fluidPage(log_init()),
#'     server = function(input, output) {
#'       set_logging_session()
#'       inspect_objects(mtcars)
#'       inspect_objects(df1 = head(mtcars), df2 = head(iris))
#'     }
#'   )
#'
#' }

inspect_objects <- function(...) {

  session <- shiny::getDefaultReactiveDomain()
  input <- session$input

  objects <- eval(list(...))
  object_names <- names(objects)

  if (NROW(objects) == 1 && is.null(object_names))  {

    object_names <- deparse(substitute(...))

  }

  if (NROW(objects) > 1 &&
      (is.null(object_names) || any(object_names == ""))
      ) {

    stop("All objects must be named.")

  }

  Map(objects, object_names,
        f = function(object, object_name) {

          # assign(object_name, value = object, envir = .GlobalEnv)
          pos <- 1
          assign(object_name, value = object, envir = as.environment(pos))

          message("Object named `", object_name,
                  "` was assigned to the global environment for debugging.\n")

  }) # end of walk2

  TRUE

} # end of inspect_objects()

#' Copying objects to global environment
#'
#' Convenient wrapper for \code{\link{inspect_objects}}.
#'
#' @inheritParams inspect_objects
#'
#' @export
inspect_object <- function(...) {

  inspect_objects(...)


}