tests/testthat/test_processSlots.R

In BoulderCodeHub/RWDataPlyr: Read and Manipulate Data from 'RiverWare'

library(RWDataPlyr)
context('check that processSlots works')

# check processSlots internal function using keyRdf and sysRdf

sla <- slot_agg_list(matrix(c('KeySlots.rdf','Mead.Pool Elevation',
                                  'AnnualRaw',NA,'meadPE'),nrow = 1))[[1]]
sla <- rbind(sla$slots, sla$annualize, sla$varNames)

sla2 <- slot_agg_list(matrix(
  c("SystemConditions.rdf", "SummaryOutputData.LBShortageConditions", 
    "EOCY", NA), 
  nrow = 1
))[[1]]
sla2 <- rbind(sla2$slots, sla2$annualize, sla2$varNames)

# warnings work -----------------
test_that("warnings are posted for agg method and data timestep mismatches", {
  expect_warning(
    RWDataPlyr:::processSlots(sla, keyRdf, 'KeySlots.rdf', findAllSlots = TRUE),
    paste0(
      "User specified aggregation is 'AnnualRaw', but the rdf contains monthly data.\n",
      "Will use 'EOCY' aggregation instead.\n",
      "If other aggregation method is desired, edit the slotAggList and call `getDataForAllScens()` again."
    ),
    fixed = TRUE
  )
  expect_warning(
    RWDataPlyr:::processSlots(
      sla2, 
      sysRdf, 
      'SystemConditions.rdf', 
      findAllSlots = TRUE
    ),
    paste0(
      "rdf contains annual data, but the aggregation method is not 'AnnualRaw'.\n",
      "Processing using 'AnnualRaw' instead.\n",
      "Edit the slotAggList and call `getDataForAllScens()` again, if necessary."
    ),
    fixed = TRUE
  )
})

# results are as expected ----------------------
sla <- slot_agg_list(matrix(c('KeySlots.rdf','Mead.Pool Elevation',
                                   'EOCY',NA),nrow = 1))[[1]]
sla <- rbind(sla$slots, sla$annualize, sla$varNames)

sla2 <- slot_agg_list(matrix(c('KeySlots.rdf','Mead.Pool Elevation',
                                   'EOCY',NA,'meadPE'),nrow = 1))[[1]]
sla2 <- rbind(sla2$slots, sla2$annualize, sla2$varNames)

df1 <- RWDataPlyr:::processSlots(
  sla, 
  keyRdf, 
  'KeySlots.rdf', 
  findAllSlots = TRUE
)
df2 <- RWDataPlyr:::processSlots(
  sla2, 
  keyRdf, 
  'KeySlots.rdf', 
  findAllSlots = TRUE
)


test_that('variable name is constructed properly', {
  expect_equal(as.character(df1$Variable[1]),'Mead.Pool Elevation_EOCY_1')
})


test_that('results match regardless of variable name', {
  expect_equal(df1$Value, df2$Value)
})

# errors work -----------------------
sla2 <- slot_agg_list(matrix(c('KeySlots.rdf','Something.Pool Elevation',
                                  'EOCY',NA),nrow = 1))[[1]]
sla2 <- rbind(sla2$slots, sla2$annualize, sla2$varNames)


# if somehow an invalid aggregation method is passed to process slots, it will 
# still get caught
sla <- sla2
sla[2,1] <- "Weird"
sla[1,1] <- "Mead.Pool Elevation"

test_that('process slots stops as expected', {
  expect_error(
    RWDataPlyr:::processSlots(sla, keyRdf, 'KeySlots.rdf', findAllSlots = TRUE),
    paste0("'", "Weird", "'", " is an invalid aggregation method.\n",
          "  Fix the slot aggregation list and try again.")
  )
  expect_error(
    RWDataPlyr:::processSlots(
      sla2, 
      keyRdf, 
      'KeySlots.rdf', 
      findAllSlots = TRUE
    ),
    'slot: Something.Pool Elevation not found in rdf: KeySlots.rdf'
  )
})

# findAllSlots == FALSE ------------------
sla2 <- slot_agg_list(matrix(c('KeySlots.rdf','Something.Pool Elevation',
                                   'EOCY',NA,"tst"),nrow = 1))[[1]]
sla2 <- rbind(sla2$slots, sla2$annualize, sla2$varNames)
df <- RWDataPlyr:::processSlots(
  sla2, 
  keyRdf, 
  "KeySlots.rdf", 
  findAllSlots = FALSE
)
test_that("data is returned when findAllSlots is FALSE", {
  expect_equal(dim(df), c(1,4))
  expect_equal(as.character(df$Variable), "tst")
  expect_equal(df$Trace, -99)
  expect_equal(df$Year, -99)
  expect_equal(df$Value, -99)
})