addAQILegend: Add an AQI legend to a map

In AirMonitor: Air Quality Data Analysis

Add an AQI legend to a map

Description

This function is a convenience wrapper around graphics::legend(). It will show the AQI colors and names by default if col and legend are not specified.

AQI categories are arranged with lower levels at the bottom of the legend to match the arrangement in the plot. This is different from the default "reading order" so you may wish to reverse the order of user supplied arguments with rev() .

Usage

addAQILegend(
  x = "topright",
  y = NULL,
  pollutant = c("PM2.5", "CO", "OZONE", "PM10", "AQI"),
  palette = c("EPA", "subdued", "deuteranopia"),
  languageCode = c("eng", "spa"),
  NAAQS = c("PM2.5_2024", "PM2.5"),
  ...
)

Arguments

x	x Coordinate passed on to the legend() command.
y	y Coordinate passed on to the legend() command.
pollutant	EPA AQS criteria pollutant.
palette	Named color palette to use for AQI categories.
languageCode	ISO 639-2 alpha-3 language code.
NAAQS	Version of NAAQS levels to use. See Note.
...	Additional arguments to be passed to legend().

Value

A list with components rect and text is returned invisbly. (See legend.)

Note

On February 7, 2024, EPA strengthened the National Ambient Air Quality Standards for Particulate Matter (PM NAAQS) to protect millions of Americans from harmful and costly health impacts, such as heart attacks and premature death. Particle or soot pollution is one of the most dangerous forms of air pollution, and an extensive body of science links it to a range of serious and sometimes deadly illnesses. EPA is setting the level of the primary (health-based) annual PM2.5 standard at 9.0 micrograms per cubic meter to provide increased public health protection, consistent with the available health science. See PM NAAQS update.

AirMonitor documentation built on Sept. 27, 2024, 9:06 a.m.