purpleairDownload: Download Purple Air PM2.5 data

Description Usage Arguments Examples

View source: R/purpleairDownload.R

Description

Download Purple Air PM2.5 data and save as csv files (each PurpleAir site per file). The indoor sites are not included by default.

Usage

1
2
purpleairDownload(site.csv, start.date, end.date, output.path, average,
  time.zone = "GMT", indoor = T, n.thread = 1)

Arguments

site.csv

a data frame of a site list or a absolute path to the site CSV file (from getPurpleairLst).

start.date

the beginning date in the format "YYYY-MM-DD".

end.date

the end date in the format "YYYY-MM-DD".

output.path

the path to output CSV files.

average

get average of this many minutes, valid values: 10, 15, 20, 30, 60, 240, 720, 1440, "daily". "daily" is not recommended as the daily values can only be calculated at the UTC time.

time.zone

time zone specification to be used for the conversion, but "" is the current time zone, and "GMT" is UTC (Universal Time, Coordinated). Invalid values are most commonly treated as UTC, on some platforms with a warning. For more time zones, see https://www.mathworks.com/help/thingspeak/time-zones-reference.html.

indoor

whether includes indoor sites (TRUE by default).

n.thread

number of parallel threads used to download the data (1 by default).

Examples

1
2
3
4
5
6
purpleairDownload(site.csv = '/absolute/path/to/the/sensorlist.csv',
    start.date = '2017-01-01',
    end.date = '2017-12-31',
    output.path = '/output_path',
    average = 60,
    time.zone = 'America/Los_Angeles')

jianzhaobi/bjzresc documentation built on Feb. 14, 2021, 7:45 a.m.