NEWS.md
pat_createHourly() as a convenience function for the common case of obtaining hourly aggergated for the following parameters: datetime, temperature, humidity, pm2.5_atm, pm2.5_atm_a, pm2.5_atm_b. Using this function greatly reduces data download volumes and allows for the most common forms of QC and correction.PurpleAir_createMonitor() to directly create monitor objects suitable for use with the AirMonitor package. This is a preliminary version of this function that includes neither QC nor correction.nowcast_QCFlag in the returned data.This version introduces data ingest functions for Clarity “Open” sensor data. In preparation for additional data providers, many of the PurpleAir functions using "pa" as shorthand have been renamed with a more explicit "PurpleAir":
pa_~() functions to PurpleAir_~().PURPLE_AIR_API_~ API keys to PurpleAir_API_~.purple_air_synoptic class to PurpleAir_synoptic.Clarity “Open” datasets are available to those with an API key allowing access to this data. The following functions provide access to Clarity “Open” data:
Clarity_getAllOpenHourly()Clarity_getAllOpenIndividual()Clarity_getOpenHourly()Clarity_getOpenIndividual()Clarity_createOpenSynoptic()Clarity_enhanceRawSynopticData()Clarity_createOpenMonitor()Generic synoptic data from non-PurpleAir providers (similar to PurpleAir ‘pas’ objects) is supported with:
PurpleAir_API_READY_KEY instead of MY_API_READ_KEY.show_only is used, spatial bounding information is ignored in: PurpleAir_getSensorsData(), pas_downloadParseRawData() and pas_createNew().pat_filter()pat_filterDate()pat_filiterDatetime()pat_trimDate()Added full support for the PurpleAir API described at https://api.purpleair.com.
Improvements include wrapper functions for PurpleAir API endpoints:
PurpleAir_PurpleAir_checkApiKey()PurpleAir_getSensorData(), PurpleAir_getSensorHistoryCSV(), PurpleAir_getSensorHistory(), PurpleAir_getSensorsData()
PurpleAir_createGroup(), PurpleAir_createMember(), PurpleAir_delteGroup(), PurpleAir_deleteMember(), PurpleAir_getGroupDetail(), PurpleAir_getGroupsList(), PurpleAir_getMemberData(), PurpleAir_getMemberHistory(), PurpleAir_getMembemrsData()
Additional updates include:
fields strings for PurpleAir_DATA_PM25_FIELDS and PurpleAir_HISTORY_PM25_FIELDS
fields argument to pas_downloadParseRawData().locationID. (See geohashTools for reasons to use a geohash as a unique location identifier.)pas_downloadParseRawData() to use the new wrapper functions.pas_enhanceRawData() and pas_createNew() to harmonize argument names.pat_downloadParseRawData() using the new wrapper functions.pat_createNew() and example_pat dataset.pat_check(), pat_isValid(), pat_isEmpty(), pat_distinct(), pat_getData(), pat_getMeta().Documentation improvements to include links to PurpleAir Terms of service and Data license.
The AirSensor2 package is a refactoring of the core, data access and manipulation functionality found in the AirSensor package. The goal in AirSensor2 is to create a lean and generic package focused on data ingest and basic data manipulation.
Initial functions to download and work with Purple Air synoptic data.