R/plan_APICalls.R

In aWhereAPI/aWhere-R-Library: API calls for aWhere API

#' @title Plan Logic of API Calls
#'
#' @description
#' \code{plan_APICalls} Calculate logic of API calls
#'
#' @details
#' Calculate logic of API calls based on the number of days that can be returned
#' with each call as well as start and end dates
#' 
#' @return list(allDates,loops)

plan_APICalls <- function(day_start
                          ,day_end
                          ,numObsReturned
                          ,includesLeapYear = TRUE) {

  
  #We need to make sure Feb 29th is included if appropriate
  if (day_end < day_start) {
    if (includesLeapYear == TRUE & lubridate::yday(day_start) > 60) {
      day_start <- ymd(day_start) - 366 #gets to same dayOfYear 1 year later
    } else if (includesLeapYear == TRUE & lubridate::yday(day_start) <= 60) {
      day_end <- ymd(day_end) + 366 #gets to same dayOfYear 1 year later
    }
  }
  
  numOfDays <- as.numeric(difftime(lubridate::ymd(day_end)
                                   ,lubridate::ymd(day_start)
                                   , units = 'days'))
  allDates <- seq(as.Date(lubridate::ymd(day_start))
                  ,as.Date(lubridate::ymd(day_end))
                  , by="days")

  loops <- ((length(allDates))) %/% numObsReturned
  remainder <- ((length(allDates))) %% numObsReturned


  if(remainder > 0) {
    loops <- loops + 1
  }


  return(list(allDates,loops))
}