stat_AQCategory: Add air quality categories to a plot

In MazamaScience/AirMonitorPlots: Plot Utilities for the AirMonitor Package

Add air quality categories to a plot

Description

This function calculates the air quality categories for the data and colors the data by AQ cateogry when it is added to a plot. The default is to add them as bars.

Usage

stat_AQCategory(
  mapping = NULL,
  data = NULL,
  mv4Colors = FALSE,
  nowcast = TRUE,
  geom = "bar",
  position = "identity",
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE,
  ...
)

Arguments

mapping	Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.
data	The data to be displayed in this layer. There are three options: if NULL, the default, the data is inherited from the plot data. A data.frame or other object, will override the plot data. A function will be called witha single argument, the plot data. The return value must be a data.frame, and will be used as the layer data.
mv4Colors	If TRUE, use the colors used in the monitoring v4 site. Otherwise, use the "official" AQI colors.
nowcast	If TRUE, y values will be transformed using stat_nowcast.
geom	The geometic object to display the data
position	Position adjustment, either as a string, or the result of a call to a position adjustment function.
na.rm	remove NA values from data
show.legend	logical indicating whether this layer should be included in legends.
inherit.aes	if FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and the aesthetics and shouldn't inherit behaviour from the default plot specificatino, eg borders().
...	additional arguments passed on to layer(), such as aesthetics.

Examples

ggplot_pm25Timeseries(
  AirMonitor::Carmel_Valley,
  startdate = 20160801,
  enddate = 20160815
) +
  stat_AQCategory()

ggplot_pm25Timeseries(
  AirMonitor::Carmel_Valley,
  startdate = 20160801,
  enddate = 20160805
) +
  geom_line() +
  stat_AQCategory(
    geom = "point",
    size = 2,
    shape = 21,
    color = 1
  )

MazamaScience/AirMonitorPlots documentation built on Oct. 13, 2023, 8:49 a.m.