R/downloadGFED.R

In pik-piam/mrcommons: MadRat commons Input Data Library

#' @title Download GFED
#' @description Download the GFED (Global Fire Emissions Database) dataset for all years not labeled
#' as beta, in addition to the emission factors.
#'
#' @author Michael S. Crawford
#' @seealso [downloadSource()] [readGFED()]
#' @examples \dontrun{
#' a <- downloadSource()
#' }
#'
#' @importFrom purrr walk
#' @importFrom utils download.file

downloadGFED <- function() {
  # yearly GFED data
  baseURL <- "https://www.geo.vu.nl/~gwerf/GFED/GFED4/"
  years <- seq(1997, 2016) # ignoring current years in beta
  walk(
    .x = years,
    .f = ~ {
      yearURL <- paste0("GFED4.1s_", .x, ".hdf5")
      download.file(paste0(baseURL, yearURL), destfile = yearURL)
      Sys.chmod(yearURL, "664", use_umask = FALSE)
    }
  )

  # emission factors
  emissionFactorsURL <- "ancill/GFED4_Emission_Factors.txt"
  download.file(paste0(baseURL, emissionFactorsURL), destfile = "GFED_emissionsFactors.txt")

  return(list(
    url          = baseURL,
    title        = "Global Fire Emissions Database",
    description  = "C and DM emissions from the burning of plant biomass globally, with emission factors.",
    revision     = "4.1",
    comment      = "Readme documentation can be found here: https://www.geo.vu.nl/~gwerf/GFED/GFED4/Readme.pdf",
    unit         = paste("Spatial data is reported in kg X m^-2 (0.25x0.25 degree grid cells),",
                         "emission factors are reported in g X per kg."),
    release_date = "2015-07-03",
    license      = "Creative Commons Attribution 3.0 License",
    author       = "Global Fire Emissions Database"
  ))
}