R/describe_data.R

In misc: Miscellaneous Functions for Data and Geospatial Work

#' Describe data
#'
#' @param data a data frame
#'
#' @return a skimr object
#'
#' @export
#'
#' @examples
#' \donttest{
#' nice_data <- data.frame(c1 = c(1, NA), c2 = c(NA, NA))
#' nice_data %>%
#'   describe_data()
#' }
describe_data <- function(data) {
  check_require("skimr")
  data %>%
    skimr::skim()
}