R/getPeriodInfo.R

In gandiwan/datim-validation: External validation routines for data payloads in DATIM

#' @export
#' @title getPeriodInfo(ISO)
#' @description Get information like start date, end date and period type from an ISO period string
#'
#' @param ISO Formatted string such as 2016Q1. Refer to DHIS2 documentation for details.
#' @return Returns a data frame of  ISO, startDate,endDate,and periodtype
#' 
getPeriodInfo <- function(ISO = NA) {

  url <- URLencode(paste0(getOption("baseurl"),"api/sqlViews/TTM90ytCCdY/data.json"))
  sig <- digest::digest(paste0(url), algo = 'md5', serialize = FALSE)
  p <- getCachedObject(sig)
  
  if (is.null(p)) {
    r <- httr::GET(url , httr::timeout(60))
    if (r$status == 200L) {
      r <- httr::content(r, "text")
      r <- jsonlite::fromJSON(r)
      if (length(r$rows) > 0) {
        p <- as.data.frame(r$rows,stringsAsFactors = FALSE)
        names(p) <- r$headers$name
        p$enddate<-as.Date(p$enddate,"%Y-%m-%d")
        p$startdate<-as.Date(p$startdate,"%Y-%m-%d")
        saveCachedObject(p, sig)
      } else {
        print(paste0("Period with ISO identifier", ISO, "not found"))
        stop()
      } 
      
      }
    else {
      print("Could not retreive period information")
      stop()
    }
  }
  if (!is.na(ISO)) {
    assertthat::assert_that(length(ISO) == 1)
  p <- p[p$iso == ISO,] }
  return(p)
}