R/openmeteo.R

In openmeteo: Retrieve Weather Data from the Open-Meteo API

#' @title openmeteo: retrieve weather data from the Open-Meteo API
#'
#' @description `openmeteo` provides functions for accessing the Open-Meteo
#'   weather API, enabling the desired weather data or forecasts to be retrieved
#'   in a tidy data format. An API key is _not_ required to access the
#'   Open-Meteo API.
#'
#'   Open-Meteo provides several API endpoints through the following functions:
#'
#'   **Core Weather APIs**
#'   - [weather_forecast()] - retrieve weather forecasts for a location
#'   - [weather_history()] - retrieve historical weather observations for a
#'   location
#'   - [weather_now()] - simple function to return current weather for a
#'   location
#'   - [weather_variables()] - retrieve a shortlist of valid forecast or
#'   historical weather variables provided
#'
#'   **Other APIs**
#'   - [geocode()] - return the co-ordinates and other data for a location name
#'   - [climate_forecast()] - return long-range climate modelling for a location
#'   - [river_discharge()] - return flow volumes for the nearest river
#'   - [marine_forecast()] - return ocean conditions data for a location
#'   - [air_quality()] - return air quality data for a location
#'
#'   Please review the API documentation at <https://open-meteo.com/> for
#'   details regarding the data available, its types, units, and other caveats
#'   and considerations.
#'
#' @docType package
#' @name openmeteo
#' @aliases openmeteo-package
NULL