Function Overview

This document has been updated to reflect functions in AirSensor version 0.4.7.

Synoptic Data

Purple Air Synoptic (PAS) data provides a view of their sensor network with location metadata and an instantaneous view of measured values. Within the AirSensor package, this data is availabe as a pas object. All functions beginning with pas_ are designed for obtaining or working with this data. The following functions are the most common end-user functions:

function params
Creating a pas
pas_createNew() baseUrl, countryCodes, includePWFSL, lookbackDays
Loading a pas
pas_load() datestamp, retries, timezone, archival
Mainpulating a pas
pas_filter() pas, ...
pas_filterArea() pas, w, e, s, n
pas_filterNear() pas, longitude, latitude, radius
Plotting a pas
pas_leaflet() pas, parameter, ...
pas_staticMap() pas, parameter, ...

Timeseries Data

Purple Air Timeseries (PAT) data is available on a per-sensor basis. Within the AirSensor package, this data is availabe as a pat object. All functions beginning with pat_ are designed for obtaining or working with this data. The following functions are the most common end-user functions:

function params
Creating a pat
pat_createNew() pas, label, id, startdate, enddate, timezone
Loading a pat
pat_load() label, startdate, enddate, days, timezone
pat_loadLatest() label
pat_loadMonth() label, datestamp, timezone
Mainpulating a pat
pat_filter() pat, ...
pat_filterDate() pat, startdate, enddate, ...
pat_join() pat, pat, ...
pat_outliers() pat, windowSize, thresholdMin, replace, showPlot, ...
pat_qc() pat, ...
pat_sample() pat, sampleSize
Plotting a pat
pat_dygraph() pat, parameter, sampleSize, ...
pat_multiPlot() pat, plottype, sampleSize, ...
pat_scatterPlot() pat, parameters, sampleSize, ...
Other functions
pat_aggregate() pat, period
pat_externalFit() pat, ...
pat_internalFit() pat, ...
pat_monitorComparison() pat, ...

Hourly Aggregated Data

Hourly Aggregated data can be generated from pat objects with the pat_createAirSensor() function. Within the AirSensor package, this data is availabe as an airsensor object. All functions beginning with sensor_ are designed for obtaining or working with this data. The following functions are the most common end-user functions:

function params
Creating an airsensor
pat_createAirSensor() pat, period, parameter, channel, qc_algorithm, ...
Loading an airsensor
sensor_load() collection, startdate, enddate, days, timezone
sensor_loadLatest() collection
sensor_loadMonth() collection, datestamp, timezone
sensor_loadYear() collection, datestamp, timezone
Mainpulating an airsensor
sensor_filter() sensor, ...
sensor_filterMeta() sensor, ...
sensor_filterDate() sensor, startdate, enddate, ...
Plotting an airsensor
sensor_polarPlot() sensor, windData, ...
sensor_pollutionRose() sensor, windData, ...
sensor_videoFrame() sensor, communityRegion, ...

Note that each airsensor object is also a ws_monitor object and can be manipulated and plotted with functions from the PWFSLSmoke package.