R/check_if_rba_ts.R

In readrba: Download and Tidy Data from the Reserve Bank of Australia

#' Perform a minimal check to see if a dataframe is formatted in a standard
#' way for an RBA time series spreadsheet.
#' Checks to see if various strings are present in the first column of the DF.
#' @param df A data frame
#' @return Logical; `TRUE` if `df` contains the expected strings in first col;
#' `FALSE` if not.
#' @keywords internal

check_if_rba_ts <- function(df) {
  stopifnot(inherits(df, "data.frame"))

  first_col <- df[[1]]

  metadata_present <- c("title", "description", "source") %in% tolower(first_col)

  all_metadata_present <- all(metadata_present)

  return(all_metadata_present)
}