R/bluesky_findModels.R

In MazamaScience/AirFireModeling: Utilities for Working with Monitoring Data and Smoke Model Output

#' @export
#' @importFrom dplyr filter
#' @importFrom rlang .data
#' @title Find models covering a location
#'
#' @description Searches \code{bluesky_modelInfo} for all models whose domain
#' includes the incoming location.
#'
#' @param longitude the target longitude
#' @param latitude the target latitude
#'
#' @return Vector of model names.
#'
#' @examples
#' library(AirFireModeling)
#' setModelDataDir('~/Data/BlueSky')
#'
#' # Models covering Portland, Oregon
#' bluesky_findModels(
#'   longitude = -122.68,
#'   latitude = 45.52
#' )
#'
bluesky_findModels <- function(
  longitude = NULL,
  latitude = NULL
) {

  MazamaCoreUtils::stopIfNull(longitude)
  MazamaCoreUtils::stopIfNull(latitude)

  # Use the information found in bluesky_modelInfo
  models <-
    dplyr::filter(
      bluesky_modelInfo,
      longitude >= .data$MIN_LONGITUDE &
        longitude <= .data$MAX_LONGITUDE &
        latitude >= .data$MIN_LATITUDE &
        latitude <= .data$MAX_LATITUDE
    ) %>%
    dplyr::pull(.data$modelName)

  return(models)

}