# Process and Display Data from Air Quality Sensors

## Documentation for package ‘AirSensor’ version 1.0.8

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A E G I M P S T

## -- A --

AirSensor | Data access and analysis functions for PurpleAir sensor data
ArchiveBaseDir | Base directory for pre-generated data
ArchiveBaseUrl | Base URL for pre-generated data

## -- E --

example_pas | Example Purple Air Synoptic dataset
example_pas_raw | Example raw Purple Air Synoptic dataset
example_pat | Example PurpleAir Timeseries dataset
example_pat_failure_A | Example PurpleAir Timeseries dataset exhibiting moderate errors
example_pat_failure_B | Example PurpleAir Timeseries dataset exhibiting severe errors
example_sensor | Example AirSensor Timeseries dataset
example_sensor_scaqmd | Example AirSensor Timeseries dataset

## -- G --

getArchiveBaseDir | Get data archive base directory
getArchiveBaseUrl | Get data archive base URL

## -- I --

initializeMazamaSpatialUtils | Initialize MazamaSpatialUtils package

## -- M --

multi_ggplot | Display multiple plots on one page

## -- P --

pas_addAirDistrict | Add an air district to PurpleAir Synoptic Data
pas_addCommunityRegion | Add an air district to PurpleAir Synoptic Data
pas_addSpatialMetadata | Add Spatial Metadata to PurpleAIr Synoptic Data
pas_addUniqueIDs | Add Unique Identifiers to PurpleAir Synoptic Data
pas_createNew | Load latest PurpleAir synoptic data
pas_downloadParseRawData | Download synoptic data from PurpleAir
pas_enhanceData | Enhance synoptic data from PurpleAir
pas_filter | General purpose filtering for PurpleAir Synoptic objects
pas_filterArea | Rectangle area filtering for PurpleAir Synoptic objects
pas_filterNear | Find PurpleAir sensors within radial distance
pas_getColumn | Return column of data from filtered PurpleAir Synoptic objects
pas_getDeviceDeploymentIDs | Return timeseries identifiers from filtered PurpleAir Synoptic objects
pas_getIDs | Return IDs from filtered PurpleAir Synoptic objects
pas_getLabels | Return labels from filtered PurpleAir Synoptic objects
pas_hasSpatial | Test for spatial metadata in _pa_synoptic_ object
pas_isEmpty | Test for an empty _pa_synoptic_ object
pas_isPas | Test for correct structure in a _pa_synoptic_ object
pas_leaflet | Leaflet interactive map of PurpleAir sensors
pas_load | Load PurpleAir synoptic data
pas_palette | Color palettes for PurpleAir
pas_staticMap | Static map of PurpleAir sensors
pas_upgrade | Upgrade _pa_synoptic_ object format
patData_aggregate | Aggregate PurpleAir Timeseries Data
pat_aggregate | Aggregate PurpleAir Timeseries Object
pat_aggregateOutlierCounts | Aggregate data with count of outliers in each bin
pat_createAirSensor | Create an Air Sensor object
pat_createNew | Load latest PurpleAir time series data
pat_createPATimeseriesObject | Combine PurpleAir raw dataframes
pat_dailySoH | Daily state of health
pat_dailySoHIndexPlot | Daily State of Health metric plot
pat_dailySoHIndex_00 | State of Health index plot
pat_dailySoHPlot | Daily State of Health metric plot
pat_distinct | Retain only distinct data records in pat$data
pat_downloadParseRawData | Download PurpleAir timeseries data
pat_dygraph | Interactive time series plot
pat_externalFit | Linear model fitting of PurpleAir and federal PWFSL time series data
pat_extractData | Extract dataframes from _pat_ objects
pat_extractDataFrame | Extract dataframes from _pat_ objects
pat_extractMeta | Extract dataframes from _pat_ objects
pat_filter | General purpose data filtering for PurpleAir Timeseries objects
pat_filterDate | Date filtering for PurpleAir Timeseries objects
pat_filterDatetime | Datetime filtering for PurpleAir Timeseries objects
pat_internalFit | Linear model fitting of channel A and B time series data
pat_isEmpty | Test for an empty _pat_ object
pat_isPat | Test for correct structure in a _pat_ object
pat_join | Join PurpleAir time series data for a single sensor
pat_load | Load PurpleAir time series data for a time period
pat_loadLatest | Load PurpleAir time series data for a week
pat_loadMonth | Load PurpleAir time series data for a month
pat_monitorComparison | Comparison of Purple Air and federal monitoring data
pat_multiPlot | Display multiple plots on one page
pat_multiplot | Display multiple plots on one page
pat_outliers | Detect and replace time series outliers
pat_qc | Apply quality control on PurpleAir Timeseries object
pat_sample | Sample PurpleAir time series data
pat_scatterPlotMatrix | Draw a matrix of PurpleAir Timeseries data scatter plots
pat_trimDate | Trim a PurpleAir Timeseries object to full days
pat_upgrade | Upgrade PurpleAir Timeseries
PurpleAirQC_hourly_AB_00 | Apply hourly aggregation QC using "AB_OO" algorithm
PurpleAirQC_hourly_AB_01 | Apply hourly aggregation QC using "AB_O1" algorithm
PurpleAirQC_hourly_AB_02 | Apply hourly aggregation QC using "AB_O2" algorithm
PurpleAirQC_hourly_AB_03 | Apply hourly aggregation QC using "AB_O4" algorithm
PurpleAirSoH_dailyABFit | Daily linear model fit values
PurpleAirSoH_dailyABtTest | Daily t-test
PurpleAirSoH_dailyMetFit | Daily fit values
PurpleAirSoH_dailyPctDC | Daily DC Signal percentage
PurpleAirSoH_dailyPctReporting | Daily reporting percentage
PurpleAirSoH_dailyPctValid | Daily valid percentage
PurpleAirSoH_dailyToIndex_00 | Daily state of health index
pwfsl_load | Get PWFSLSmoke monitoring data
pwfsl_loadLatest | Get PWFSLSmoke monitoring data

## -- S --

scatterPlot | Matrix scatter plot variables in a data frame
sensor_calendarPlot | Plot time series values in conventional calendar format
sensor_extractData | Extract dataframes from _airsensor_ objects
sensor_extractDataFrame | Extract dataframes from _airsensor_ objects
sensor_extractMeta | Extract dataframes from _airsensor_ objects
sensor_filter | Data filtering for AirSensor objects
sensor_filterDate | Date filtering for AirSensor objects
sensor_filterDatetime | Datetime filtering for AirSensor objects
sensor_filterMeta | Metadata filtering for AirSensor objects
sensor_isEmpty | Test for an empty _sensor_ object
sensor_isSensor | Test for correct structure in a _sensor_ object
sensor_join | Join airsensor objects from different time periods
sensor_load | Load hourly-aggregated PurpleAir data
sensor_loadLatest | Load hourly-aggregated PurpleAir data for a week
sensor_loadMonth | Load hourly-aggregated PurpleAir data for a month
sensor_loadYear | Load hourly-aggregated PurpleAir data for a month
sensor_polarPlot | Plot bivariate polar plots with guassian smoothing
sensor_pollutionRose | Pollution rose plot
setArchiveBaseDir | Set data archive base directory
setArchiveBaseUrl | Set data archive base URL
spatialIsInitialized | Check if MazamaSpatialUtils has been initialized

## -- T --

timeseriesTbl_multiPlot | Faceted plot of a timeseries tibble