R/txIndices.R

In cphotiadou/scenarioIndices: Calculate indices for KNMI climate scenarios

#' Calculates a set of TX related indices
#'
#' @description Calculates a set of daily maximum temperature related indices as
#' they were defined for the KNMI14 scenarios brochure
#' @param index      indices ("nID", "nWD", "nSD", "nTD", "aTX")
#' @inheritParams TempAvgIndices
#' @export
TempMaxIndices <- function(input, index,
                          ofile = NA, scenario,
                          horizon=2030, season,
                          regions = "NLD") {


  if (!index %in% c("nID", "nWD", "nSD", "nTD", "aTX")){
    stop("index should be one of nID nWD nSD nTD aTX")
  }


  if (class(input) != "knmiTF") {
    input <- ReadInput("tx", input)
  }

  if (!scenario %in% c("GL", "GH", "WL", "WH") &&
      horizon != c(2030, 2050, 2085)) {
    input <- input$obs
  } else {
    input <- TransformTemp(input = input, ofile = NA, scenario=scenario,
                           horizon = horizon, var = "tx", regions = regions)
    input <- input[-c(1:5), ]
  }

  input <- as.data.frame(input)

  seasonalSplit <- SeasonalSplit(season, input[, 1])
  id  <- seasonalSplit$id
  idy <- seasonalSplit$idy

  #Indices
  switch(index,
         "nID" = X <- aggregate(input[id,-1] < 0,by=list(idy),  sum),
         "nWD" = X <- aggregate(input[id,-1] >= 20,by=list(idy),  sum),
         "nSD" = X <- aggregate(input[id,-1] >= 25,by=list(idy),  sum),
         "nTD" = X <- aggregate(input[id,-1] >= 30,by=list(idy),  sum),
         "aTX" = X <- aggregate(input[id,-1],by=list(idy),  mean))

  return(X)
}

#' Calculates a set of TX related indices for all scenarios, horizons, and
#' seasons at once
#'
#' @description Calculates a set of daily maximum temperature related indices as
#' they were defined for the KNMI14 scenarios brochure
#' @inheritParams TempMaxIndices
#' @export
TempMaxIndicesWrapper <- function(input, regions = "NLD", ofile = NA) {

  if (class(input) != "knmiTF") {
    input <- ReadInput("tx", input)
  }

  fn <- function(index, season, scenario, horizon) {
    tmp <- TempMaxIndices(input = input, index = index, ofile = ofile,
                          scenario = scenario, horizon = horizon, season = season,
                          regions = regions)
    tmp$season   <- season
    tmp$horizon  <- horizon
    tmp$scenario <- scenario
    tmp$index    <- index
    tmp
  }


  indices <- c("nID", "nWD", "nSD", "nTD", "aTX")

  combinations <- MakeCombinations(indices)

  result <- pmap(combinations, fn)
  result <- rbindlist(result)
  setnames(result, "Group.1", "year")
  nCols <- ncol(result)
  names <- colnames(result)
  setcolorder(result, names[c( (nCols - (0:3)), 1, 2 : (nCols-4))])
  result
}