pat_load: Load PurpleAir time series data for a time period

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

Load PurpleAir time series data for a time period

Description

A pre-generated PurpleAir Timeseries pat object will be loaded for the given time interval if available. Data are loaded from the archive set with either setArchiveBaseUrl() or setArchiveBaseDir() for locally archived files.

Dates can be anything that is understood by MazamaCoreUtils::parseDatetime() including any of the following recommended formats:

• "YYYYmmdd"

• "YYYY-mm-dd"

• "YYYY-mm-dd HH:MM:SS"

When no dates are specified, pat_loadLatest() is used, loading data for the last 7 days.

Usage

pat_load(
  id = NULL,
  label = NULL,
  pas = NULL,
  startdate = NULL,
  enddate = NULL,
  timezone = "America/Los_Angeles"
)

Arguments

id	PurpleAir sensor 'deviceDeploymentID'.
label	PurpleAir sensor 'label'.
pas	PurpleAir Synoptic pas object.
startdate	Desired start time (ISO 8601) or POSIXct.
enddate	Desired end time (ISO 8601) or POSIXct.
timezone	Timezone used to interpret start and end dates.

Value

A PurpleAir Timeseries pat object.

Note

Archive file names are generated with a unique "device-deployment" identifier by combining a unique location ID with a unique device ID. These "device-deployment" identifiers guarantee that movement of a sensor will result in the creation of a new time series.

Users may request a pat object in one of two ways:

1) Pass in id with a valid a deviceDeploymentID

2) Pass in both label and pas so that the deviceDeploymentID can be looked up.

See Also

pat_loadLatest

pat_loadMonth

pat_createNew

Examples

# Fail gracefully if any resources are not available
try({

library(AirSensor)

setArchiveBaseUrl("https://airsensor.aqmd.gov/PurpleAir/v1")

# Reference an older 'pas' before this sensor was dropped
pas <- pas_load(20190901, archival = TRUE)

pat <- pat_load(
  label = "SCNP_20", 
  pas = pas,
  startdate = 20190411, 
  enddate = 20190521
)

pat_multiPlot(pat)

}, silent = FALSE)

MazamaScience/AirSensor documentation built on April 28, 2023, 11:16 a.m.