feat: new maximum date ranges in pat_create()

MazamaScience · May 31, 2024 · b751236 · b751236
1 parent 02f87bc
commit b751236
Show file tree

Hide file tree

Showing 88 changed files with 182 additions and 100 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Type: Package
 Package: AirSensor2
-Version: 0.5.0
+Version: 0.5.1
 Title: Process and Display Data from Air Quality Sensors
 Authors@R: c(
     person("Jonathan", "Callahan", email="[email protected]", role=c("aut","cre"))
@@ -27,7 +27,7 @@ Imports:
     magrittr,
     MazamaLocationUtils (>= 0.4.3),
     MazamaSpatialUtils (>= 0.8.6),
-    MazamaTimeSeries (>= 0.2.16),
+    MazamaTimeSeries (>= 0.3.0),
     readr,
     rlang,
     sf,
@@ -44,4 +44,4 @@ Language: en-US
 LazyData: true
 Repository: CRAN
 VignetteBuilder: knitr
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,17 @@
+# AirSensor2 0.5.1
+
+Updated the of data that can be requested in a single call in `pat_create()` to
+match updates to the PurpleAir API:
+
+| Average Period | Previous Limit | New Limit |
+| -------------- | -------------- | --------- |
+| Real-Time | 2 Days | 30 Days |
+| 10 Minutes | 3 Days | 60 Days |
+| 30 Minutes | 7 Days | 90 Days |
+| 1 Hour | 14 Days | 180 Days |
+| 6 Hours | 90 Days | 1 Year |
+| 1 Day | 1 Year | 2 Years |
+
 # AirSensor2 0.5.0
 
 Version 0.5 introduces changes in the default parameters that are requested

diff --git a/R/pat_create.R b/R/pat_create.R
@@ -26,8 +26,8 @@
 #' @return A PurpleAir Timeseries \emph{pat} object.
 #'
 #' @description Create a \code{pat} object for a specific \code{sensor_index}.
-#' This function splits up the requested time range into 2-day intervals (the
-#' maximum allowed by the PurpleAir API) and makes repeated calls to
+#' This function splits up the requested time range into multi-day intervals (as
+#' required by the PurpleAir API) and makes repeated calls to
 #' \code{pat_downloadParseRawData()}. The \code{sleep} parameter waits a small
 #' amount of time between API requests.
 #'
@@ -154,6 +154,7 @@ pat_create <- function(
 
   # Create a valid dateRange
   if ( !is.null(startdate) && !is.null(enddate) ) {
+
     # Don't require day boundaries
     dateRange <- MazamaCoreUtils::timeRange(
       starttime = startdate,
@@ -163,7 +164,9 @@ pat_create <- function(
       ceilingStart = FALSE,
       ceilingEnd = FALSE
     )
+
   } else {
+
     # Default to 2 days with day boundaries
     dateRange <- MazamaCoreUtils::dateRange(
       startdate = startdate,
@@ -174,10 +177,27 @@ pat_create <- function(
       ceilingEnd = FALSE,
       days = 2
     )
+
+  }
+
+  # NOTE:  On 2024-05-03, PurpleAir announced expanded time limits for
+  # NOTE:  historical data requests as reflected here:
+
+  # raw data ( average == 0 )
+  dayCount <- 30
+
+  if ( average == 10 ) {
+    dayCount <- 60
+  } else if ( average == 30 ) {
+    dayCount <- 90
+  } else if ( average == 60 ) {
+    dayCount <- 180
+  } else {
+    dayCount <- 365
   }
 
-  # Create a sequence of every-2-days POSIXct times
-  dateSequence <- seq(dateRange[1], dateRange[2], by = lubridate::ddays(2))
+  # Create a sequence of every-dayCount-days POSIXct times
+  dateSequence <- seq(dateRange[1], dateRange[2], by = lubridate::ddays(dayCount))
 
   # Tack on the final data if needed
   if ( dateRange[2] > utils::tail(dateSequence, 1) ) {
@@ -338,7 +358,7 @@ if ( FALSE ) {
   pas = example_pas_metadata
   sensor_index = "95189"
   startdate = "2024-01-01"
-  enddate = "2024-01-03"
+  enddate = "2024-01-15"
   timezone = "America/Los_Angeles"
   average = 0
   fields = PurpleAir_PAT_QC_FIELDS

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/articles/AirSensor2.html b/docs/articles/AirSensor2.html
diff --git a/docs/articles/Citations.html b/docs/articles/Citations.html
diff --git a/docs/articles/Developer_Style_Guide.html b/docs/articles/Developer_Style_Guide.html
diff --git a/docs/articles/Working_with_PurpleAir_API_Keys.html b/docs/articles/Working_with_PurpleAir_API_Keys.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -6,5 +6,5 @@ articles:
   Developer_Style_Guide: Developer_Style_Guide.html
   Citations: Citations.html
   Working_with_PurpleAir_API_Keys: Working_with_PurpleAir_API_Keys.html
-last_built: 2024-03-13T23:37Z
+last_built: 2024-05-31T21:08Z
 
diff --git a/docs/reference/APIKeys.html b/docs/reference/APIKeys.html
diff --git a/docs/reference/AirSensor2.html b/docs/reference/AirSensor2.html
diff --git a/docs/reference/Clarity_createAllOpenMonitors.html b/docs/reference/Clarity_createAllOpenMonitors.html
diff --git a/docs/reference/Clarity_createOpenMonitor.html b/docs/reference/Clarity_createOpenMonitor.html
diff --git a/docs/reference/Clarity_createOpenSynoptic.html b/docs/reference/Clarity_createOpenSynoptic.html
diff --git a/docs/reference/Clarity_enhanceRawSynopticData.html b/docs/reference/Clarity_enhanceRawSynopticData.html
diff --git a/docs/reference/Clarity_getAllOpenHourly.html b/docs/reference/Clarity_getAllOpenHourly.html
diff --git a/docs/reference/Clarity_getAllOpenIndvidual.html b/docs/reference/Clarity_getAllOpenIndvidual.html
diff --git a/docs/reference/Clarity_getOpenHourly.html b/docs/reference/Clarity_getOpenHourly.html
diff --git a/docs/reference/Clarity_getOpenIndividual.html b/docs/reference/Clarity_getOpenIndividual.html
diff --git a/docs/reference/Clarity_updateAllOpenMonitors.html b/docs/reference/Clarity_updateAllOpenMonitors.html
diff --git a/docs/reference/PurpleAir_PAList_PM25_FIELDS.html b/docs/reference/PurpleAir_PAList_PM25_FIELDS.html
diff --git a/docs/reference/PurpleAir_PAS_AVG_PM25_FIELDS.html b/docs/reference/PurpleAir_PAS_AVG_PM25_FIELDS.html
diff --git a/docs/reference/PurpleAir_PAS_METADATA_FIELDS.html b/docs/reference/PurpleAir_PAS_METADATA_FIELDS.html