R/str.R

In tanho63/tantastic: Fun and Shiny and Pretty Functions

#' Tan's str() function
#'
#' Wraps `utils::str()` but defaults to max.level = 2
#'
#' @param ... objects passed to str
#' @param max.level sets max.level - by default, 2
#'
#' @return output of utils::str() but defaults to max.level = 2
#' @export
#'
#' @examples
#'
#' list(
#'   data = list(
#'     mtcars = data.frame(mtcars),
#'     airquality = data.frame(airquality)
#'   )
#' ) |>
#'   str()
str <- function(..., max.level = 2) {
  utils::str(..., max.level = max.level)
}