R/AirSensor2-package.R

In MazamaScience/AirSensor2: Process and Display Data from Air Quality Sensors

#' @keywords internal
"_PACKAGE"

#' @name AirSensor2
#' @title Air Quality Data Analysis for low-cost Sensors
#' @description
#' \code{
#' Utilities for working with air quality monitoring data from low-cost sensors
#' with a focus on small particulates (PM2.5). Initial focus is on sensors
#' produced by 'PurpleAir' <https://www2.purpleair.com>.
#' }
#'
#' @references \href{https://www2.purpleair.com}{PurpleAir}
#' @references \href{https://api.purpleair.com}{PurpleAir API}
#' @references \href{https://www2.purpleair.com/policies/terms-of-service}{PurpleAir Terms of service}
#' @references \href{https://www2.purpleair.com/pages/license}{PurpleAir Data license}
#' @references \href{https://www2.purpleair.com/pages/attribution}{PurpleAir Data Attribution}
NULL


# ----- AQI categories ---------------------------------------------------------

#' @title US EPA AQI Index levels, names, colors and action text
#'
#' @description
#' Official, US EPA AQI levels, names, colors and action text are provided in a
#' list for easy coloring and labeling.
#'
#' See \code{AirMonitor::\link[AirMonitor:US_AQI]{US_AQI}} for details.
#'
#' @name US_AQI
#' @rdname US_AQI
#' @export
#' @importFrom AirMonitor US_AQI
NULL