R/data.R

In openairmaps: Create Maps of Air Pollution Data

#' Example data for polar mapping functions
#'
#' The `polar_data` dataset is provided as an example dataset as part of
#' the `openairmaps` package. The dataset contains hourly measurements of
#' air pollutant concentrations, location and meteorological data.
#'
#' `polar_data` is supplied with the `openairmaps` package as an
#' example dataset for use with documented examples.
#'
#' @name polar_data
#' @docType data
#' @format Data frame with example data from four sites in London in 2009.
#' \describe{
#'   \item{date}{The date and time of the measurement}
#'   \item{nox, no2, pm2.5, pm10}{Pollutant concentrations}
#'   \item{site}{The site name. Useful for use with the `popup` and `label` arguments in `openairmaps` functions.}
#'   \item{latitude, longitude}{Decimal latitude and longitude of the sites.}
#'   \item{site.type}{Site type of the site (either "Urban Traffic" or "Urban Background").}
#'   \item{wd}{Wind direction, in degrees from North, as a numeric vector.}
#'   \item{ws}{Wind speed, in m/s, as numeric vector.}
#'   \item{visibility}{The visibility in metres.}
#'   \item{air_temp}{Air temperature in degrees Celcius.}
#' }
#' @source `polar_data` was compiled from data using the
#'   [openair::importAURN()] function from the `openair` package with
#'   meteorological data from the `worldmet` package.
#'
#' @keywords datasets
#' @examples
#'
#' # basic structure
#' head(polar_data)
#'
NULL

#' Example data for trajectory mapping functions
#'
#' The `traj_data` dataset is provided as an example dataset as part of the
#' `openairmaps` package. The dataset contains HYSPLIT back trajectory data for
#' air mass parcels arriving in London in 2009. It has been joined with air
#' quality pollutant concentrations from the "London N. Kensington" AURN urban
#' background monitoring site.
#'
#' `traj_data` is supplied with the `openairmaps` package as an example dataset
#' for use with documented examples.
#'
#' @format A data frame with 53940 rows and 10 variables:
#' \describe{
#'   \item{date}{The arrival time of the air-mass}
#'   \item{receptor}{The receptor number}
#'   \item{year}{Trajectory year}
#'   \item{month}{Trajectory month}
#'   \item{day}{Trajectory day}
#'   \item{hour}{Trajectory hour}
#'   \item{hour.inc}{Trajectory hour offset from the arrival date}
#'   \item{lat}{Latitude}
#'   \item{lon}{Longitude}
#'   \item{height}{Height of trajectory in m}
#'   \item{pressure}{Pressure of the trajectory in Pa}
#'   \item{date2}{Date of the trajectory}
#'   \item{nox}{Concentration of oxides of nitrogen (NO + NO2)}
#'   \item{no2}{Concentration of nitrogen dioxide (NO2)}
#'   \item{o3}{Concentration of ozone (O3)}
#'   \item{pm10}{Concentration of particulates (PM10)}
#'   \item{pm2.5}{Concentration of fine particulates (PM2.5)}
#' }
#' @source `traj_data` was compiled from data using the [openair::importTraj()]
#'   function from the `openair` package with air quality data from
#'   [openair::importAURN()] function.
#'
#' @keywords datasets
#' @examples
#'
#' # basic structure
#' head(traj_data)
"traj_data"