R/zzz.R

In jrwalker-projects/quaker: clean, plot and map NOAA earthquake data

#' .onLoad function to resolve R CMD check note
#'
#' Package checking in R - R CMD check - doesn't currently deal with a function that passes a data frame and
#' uses explicit column names. Passing variables as quoted or quo/enquo is possible but in the case of a routine
#' like eq_clean_data that only ever intends to deal with one data frame, explicit column names seem acceptable.
#' The R CMD check can be satisfied with the list of column names in a call to GlobalVariables.
#' @param libname the library to be used - default "quaker"
#' @param pkgname the name of the package - default "quaker"
#' @return NULL
#' @note this function is note exported to the package
#' @examples .onLoad()
.onLoad <- function(libname = find.package("quaker"), pkgname = "quaker"){

  # CRAN check Note avoidance
  if(getRversion() >= "3.1.0")

    utils::globalVariables(
      #column name references to skip checking
      c("COUNTRY", "Country", "DAMAGE_DESCRIPTION", "DAMAGE_MILLIONS_DOLLARS", "DAY", "DEATHS",
        "DEATHS_DESCRIPTION", "EQ_MAG_MB", "EQ_MAG_MFA", "EQ_MAG_ML", "EQ_MAG_MS", "EQ_MAG_MW",
        "EQ_PRIMARY", "FOCAL_DEPTH", "HOUSES_DAMAGED", "HOUSES_DAMAGED_DESCRIPTION", "HOUSES_DESTROYED",
        "HOUSES_DESTROYED_DESCRIPTION", "INJURIES", "INJURIES_DESCRIPTION", "INTENSITY", "LATITUDE",
        "LOCATION_NAME", "LONGITUDE", "MISSING", "MISSING_DESCRIPTION", "MONTH", "REGION_CODE", "STATE",
        "TOTAL_DAMAGE_DESCRIPTION", "TOTAL_DAMAGE_MILLIONS_DOLLARS", "TOTAL_DEATHS", "TOTAL_DEATHS_DESCRIPTION",
        "TOTAL_HOUSES_DAMAGED", "TOTAL_HOUSES_DAMAGED_DESCRIPTION", "TOTAL_HOUSES_DESTROYED",
        "TOTAL_HOUSES_DESTROYED_DESCRIPTION", "TOTAL_INJURIES", "TOTAL_INJURIES_DESCRIPTION",
        "TOTAL_MISSING", "TOTAL_MISSING_DESCRIPTION", "YEAR", "popup_info", "yy"
      )
    )
  invisible()
}
#.onUnload <- function (libpath) {
#  library.dynam.unload("quaker", libpath)
#}