Skip to contents

Import UK Daily Air Quality Index Data

Source: R/import_ukaq_daqi.R
import_ukaq_daqi.Rd

Imports UK Daily Air Quality Index (DAQI) data for selected pollutants, years, and sites. Returned information can include the relevant daily statistic (e.g., daily average for PM10), the index (1:10), the band (Low, Moderate, High, or Very High), and the colour associated with the index and/or band.

Usage

import_ukaq_daqi(
  code = NULL,
  year,
  source = "aurn",
  pollutant = NULL,
  append_metadata = FALSE,
  metadata_columns = c("site_type", "latitude", "longitude"),
  daqi_columns = c("concentration", "poll_index", "poll_band"),
  pivot = "long",
  progress = NA,
  ...,
  .class = NULL
)

Arguments

code

Specific site codes to import.

default: NULL

code expects a vector of character values. It defines the specific sites to import will filter the result for specific sites based on their site codes, available through import_ukaq_meta(). Note that a mismatch between code and source may result in no data being imported. If NULL, the default, all available data for the year and source will be returned.

year

A year, or range of years, from which to import data.

required

year expects a vector of integer values. It can be a single year (2020), a selection of specific years (c(2020, 2021, 2022)), or a range of years (2020:2025).

source

One or more UK Monitoring networks from which to import data.

default: "ukaq"

The default, "ukaq", will look for sites from any of the available networks. Any combination of "aurn", "aqe", "saqn", "waqn", or "niaqn" will only import data from those specific monitoring networks. Note that a mismatch between code and source may result in no data being imported. The DAQI is not pre-calculated for "lmam" sites.

pollutant

One or more DAQI pollutants for which to import data.

default: NULL

By default, all available pollutants are imported. pollutant allows any specific combination of the pollutants to be returned instead. Note that this should be a DAQI pollutant - i.e., one or more of "no2", "pm10", "pm2.5", "o3" or "so2".

append_metadata

Append site metadata to the dataframe?

default: FALSE

When TRUE, the resulting data.frame will have site metadata appended. The specific columns are selected using metadata_columns.

metadata_columns

Specific metadata columns to append to the data.frame.

default: c("site_type", "latitude", "longitude")

When append_metadata = TRUE, the columns selected here will be appended to the data. Columns names should match those in import_ukaq_meta(), excluding pollutant-specific columns (e.g., ratification date).

daqi_columns

Specific DAQI columns to include.

default: c("concentration", "poll_index", "poll_band")

There are numerous DAQI-related data which can be returned within the data.frame. This option expects a vector of any combination of:

  • "concentration": The measured daily concentration.

  • "poll_index": The daily pollution index (1-10).

  • "poll_band": The pollution band (Low, Moderate, High, Very High).

  • "colour_index": The colour associated with the pollution index.

  • "colour_band": The colour associated with the pollution band.

  • "measurement_period": The name of the statistic presented in "concentration".

pivot

Should the dataframe be 'wide' or 'long'?

default: "wide"

There are two main ways to store air quality data; "long" (with 'pollutant' and 'value' columns) or "wide" (with each pollutant value being stored in its own column). pivot allows users to define which format they would prefer their data in.

progress

Show a progress bar?

default: NA

When TRUE, this function will print a progress bar to track individual files being imported. If FALSE this is suppressed. If NA, the default, the function will work out if a progress bar would be useful (i.e., if the function is being run in an interactive session and if more than one remote file is being accessed).

...

Not used.

.class

Signifier for the dataframe class.

default: NULL

ukaq functions, by default, will return tbl_dfs if the tibble package is installed, but will otherwise return data.frames. .class can override this behaviour, and takes either "tbl" or "df", which sets the return class to be tbl_df or data.frame respectively.

Value

a data.frame

References

With thanks to Trevor Davies and Ricardo Plc for preparing and hosting the data

See also

https://uk-air.defra.gov.uk/air-pollution/daqi for more information about the DAQI.

Author

Jack Davison, David Carslaw