R/utils.R

In rstudio/rscpages: Organize and Curate Your Content Within 'Posit Connect'

format_iso8601 <- function(str) {
  strptime(str, "%Y-%m-%dT%H:%M:%SZ", tz = "UTC")
}

#' Evaluates required columns for widget's input
#' @param widget Widget's name to identify errors thrown
#' @param colnames Column names provided from the widget content input
#' @param required List of required columns to look for in the widget's input
evaluate_widget_input <- function(widget, colnames, required) {
  for (col in required) {
    if (!any(colnames == col)) {
      msg <- sprintf(
        "%s requires a \"%s\" column but is not present.",
        widget,
        col
      )
      stop(msg)
    }
  }
}

#' Show warnings of expected columns for widget's input
#' @param widget Widget's name to identify warnings thrown
#' @param colnames Column names provided from the widget content input
#' @param expected List of expected columns to look for in the widget's input
warning_widget_input <- function(widget, colnames, expected) {
  for (col in expected) {
    if (!any(colnames == col)) {
      msg <- sprintf(
        "%s expects a \"%s\" column but is not present.",
        widget,
        col
      )
      warning(msg)
    }
  }
}

#' Show warnings for large content
#' @param content Content data frame or Crosstalk SharedData object
#' @param max_rows Maximum number of rows before warning (default 500)
warning_large_content <- function(content, max_rows = 500) {
  rows <- nrow(content)
  if (rows > max_rows) {
    warning(
      glue::glue(
        "Content items exceeds maximum ({rows} rows, max {max_rows}). ",
        "You should reduce the number of content items to avoid performance ",
        "issues."))
  }
}