Skip to content

Retrieve 'AirNow' Air Quality Observations and Forecasts

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

briandconnelly/airnow

Repository files navigation

airnow

Lifecycle: experimental CRAN status R-CMD-check Codecov test coverage

airnow is an R package for querying and retrieving air quality information from AirNow via the AirNow API. Current and historical readings as well as forecasts can be retrieved as tidy data frames.

Installation

You can install the stable version of airnow from CRAN:

install.packages("airnow")

If you’d like to try out the development version of airnow, you can install directly from GitHub:

# install.packages("remotes")
remotes::install_github("briandconnelly/airnow")

Creating an API Token

The AirNow API is generally free to use. The set_airnow_token() function can be used to help you create and configure your API token.

library(airnow)

set_airnow_token()

Examples

Current air quality in Seattle

The AirNow API allows you to query air conditions either by ZIP code or latitude/longitude. Here, we’ll get the current conditions in Seattle by ZIP code:

library(airnow)

get_airnow_conditions(zip = "98101")
#> # A tibble: 2 × 11
#>   date_observed hour_obs…¹ local…² repor…³ state…⁴ latit…⁵ longi…⁶ param…⁷   aqi
#>   <date>             <int> <fct>   <fct>   <fct>     <dbl>   <dbl> <fct>   <int>
#> 1 2022-10-31             6 PST     Seattl… WA         47.6   -122. O3         27
#> 2 2022-10-31             6 PST     Seattl… WA         47.6   -122. PM2.5      30
#> # … with 2 more variables: category_number <int>, category_name <fct>, and
#> #   abbreviated variable names ¹​hour_observed, ²​local_time_zone,
#> #   ³​reporting_area, ⁴​state_code, ⁵​latitude, ⁶​longitude, ⁷​parameter

Find the site with the lowest air quality near Washington state

library(airnow)
library(dplyr)

get_airnow_area(
  box = c(-125.394211, 45.295897, -116.736984, 49.172497),
  verbose = TRUE
) |>
  slice_max(order_by = aqi, n = 1) |>
  select(site_name, site_agency, latitude, longitude, aqi, datetime_observed)
#> # A tibble: 1 × 6
#>   site_name         site_agency        latit…¹ longi…²   aqi datetime_observed  
#>   <fct>             <fct>                <dbl>   <dbl> <int> <dttm>             
#> 1 Clarkston-13th St Washington Depart…    46.4   -117.    56 2022-10-31 13:00:00
#> # … with abbreviated variable names ¹​latitude, ²​longitude

Disclaimer

This package and its author are not affiliated with AirNow or its partners. See the Data Exchange Guidelines for more details about this data set and how it should be used. Data are typically refreshed once per hour. Please be kind to this service and limit your request rate.

About

Retrieve 'AirNow' Air Quality Observations and Forecasts

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Packages

No packages published

Languages