pat_loadMonth: Load PurpleAir time series data for a month

Description Usage Arguments Value Note See Also Examples

View source: R/pat_loadMonth.R

Description

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

The datestamp must be in the following format:

By default, the current month is loaded.

Usage

1
2
3
4
5
6
7
pat_loadMonth(
  id = NULL,
  label = NULL,
  pas = NULL,
  datestamp = NULL,
  timezone = "America/Los_Angeles"
)

Arguments

id

PurpleAir sensor 'deviceDeploymentID'.

label

PurpleAir sensor 'label'.

pas

PurpleAir Synoptic pas object.

datestamp

Date string in ymd order.

timezone

Timezone used to interpret datestamp.

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_load

pat_loadLatest

pat_createNew

Examples

1
2
3
4
5
6
7
8
9
library(AirSensor)

setArchiveBaseUrl("http://data.mazamascience.com/PurpleAir/v1")

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

may <- pat_loadMonth(label = "SCNP_20", pas = pas, datestamp = 201905)
pat_multiPlot(may)

AirSensor documentation built on March 13, 2021, 1:07 a.m.