R/ef_trend.R

In patperu/effisr: 'EFFIS' Data from R

#' Search the European Forest Fire Information System 'EFFIS'
#'
#' @export
#'
#' @param country (character) One or more country names as ISO2 code
#' @param province (character) Province name
#' @param limit (integer) Record limit
#' @param firedate (character) YYYY-MM-DD
#' @param area_ha (integer) Size of the fire
#' @param ba_class (character) One of 'ALL', '30DAYS' or '07DAYS'
#' @param ordering (character) One or more field names. Specifies the sort order.
#' The names can be optionally prefixed by “-” to indicate descending sort.
#' @param decimate (integer) pick one date every x
#' @param page (integer) Page number
#' @template otherargs

ef_trend <- function(country = NULL, province = NULL,
                     limit = NULL, firedate = NULL,
                     area_ha = NULL, ba_class = NULL,
                     ordering = NULL,
                     decimate	= NULL,
                     page = NULL, ...) {


  effisr_client <- set_effisr_client()

  res <- effisr_client$get(
            path = "rest/2/burntareas/trend",
            query = cacomp(list(country = country,
                                province = province,
                                limit = limit,
                                firedate = firedate,
                                area_ha = area_ha,
                                ba_class = ba_class,
                                decimate = decimate,
                                ordering = ordering,
                                fmt = "json")))

  if (res$status_code > 201) {
    mssg <- jsonlite::fromJSON(res$parse("UTF-8"))$message$message
    x <- res$status_http()
    stop(
      sprintf("HTTP (%s) - %s\n  %s", x$status_code, x$explanation, mssg),
      call. = FALSE
    )
  }

  txt <- jsonlite::fromJSON(res$parse("UTF-8"))

  data <- purrr::map_df(txt$trend, function(x) as.data.frame(Filter(Negate(is.null), x)))

  x <- data.frame(country = country,
                  day = names(txt$trend),
                  year_first = txt$dates$first,
                  year_last  = txt$dates$last,
                  data,
                  stringsAsFactors = FALSE)

  readr::type_convert(x, col_types = readr::cols())

}