R/utils-is.R

In elipousson/overedge: Assorted Functions For Easier Map Making

#' Is the class of this object any of the specified classes?
#'
#' @noRd
is_class <- function(x, classes = NULL, null.ok = FALSE) {
  if (is.null(x) && null.ok) {
    return(TRUE)
  }

  any(classes %in% class(x))
}

#' Is this a URL?
#'
#' @noRd
is_url <- function(x) {
  grepl(
    "http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\\(\\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+",
    x
  )
}

#' Is this an ArcGIS MapServer or FeatureServer URL?
#'
#' @noRd
is_esri_url <- function(x) {
  grepl("/MapServer|/FeatureServer", x)
}

#' Is this a Google Sheets URL?
#'
#' @noRd
is_gsheet_url <- function(x) {
  grepl("^https://docs.google.com/spreadsheets/", x)
}

#' Is this a GitHub gist URL?
#'
#' @noRd
is_gist_url <- function(x) {
  grepl("^https://gist.github.com/", x)
}

#' Is this a Google Maps URL?
#'
#' @noRd
is_gmap_url <- function(x) {
  grepl("^https://www.google.com/maps/", x)
}

#' Is this a unit class object?
#'
#' @noRd
is_unit <- function(x) {
  is_class(x, classes = "unit")
}

#' Is the df object empty (no rows)?
#'
#' @noRd
is_df_empty <- function(x, message = "This simple feature object has no rows.", quiet = FALSE) {
  is_empty <- (!is.null(x) && (nrow(x) == 0))

  if (is_empty && !quiet) {
    return(cli::cli_abort(message))
  } else if (!quiet) {
    return(NULL)
  }

  return(is_empty)
}


#' Is the df object a paper?
#'
#' @noRd
is_df_paper <- function(x, ext = FALSE, quiet = FALSE) {
  names <- c("width", "height", "orientation", "units")

  if (ext) {
    names <- c(names, "asp", "cols", "rows")
  }

  is_valid_paper <-
    rlang::has_name(x, names)

  if (!all(is_valid_paper) && !quiet) {
    return(cli::cli_abort("The data frame provided to paper provided does not appear to the required columns."))
  }

  return(all(is_valid_paper))
}